org.lsst.ccs.drivers.mks

Class TestGP390

java.lang.Object

org.lsst.ccs.drivers.mks.TestGP390

public class TestGP390
extends Object

Program to test the MKS GP390 vacuum gauge driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TestGP390.Fmode
protected static class	TestGP390.OnOff
protected static class	TestGP390.TripType
protected static class	TestGP390.Units
protected static class	TestGP390.VacType

Constructor Summary

Constructors

Constructor and Description
TestGP390()

Method Summary

Modifier and Type	Method and Description
void	assignRelay(int relay, TestGP390.VacType type) Assigns a trip relay to a vacuum type.
void	close() Closes the connection.
void	enableRelay(int relay, boolean enable) Enables/disables a trip relay.
String	isRelayActive(int relay) Gets whether a trip relay is active.
String	isRelayEnabled(int relay) Shows whether a trip relay is enabled.
void	open(GP390.ConnType connType, String ident, int baud, int address) Opens connection to a device.
String	readDiffPressure() Reads the differential pressure.
String	readPressure() Reads the vacuum pressure.
void	reset() Resets to power-on state.
void	setAtmospheric(double press) Sets the atmospheric pressure.
void	setDefaults() Sets values to factory defaults.
void	setDegasOn(TestGP390.OnOff onoff) Turns the micro-ion gauge degas on or off.
void	setDegasTime(int time) Sets the micro-ion gauge degas time.
void	setDelayOn(TestGP390.OnOff onoff) Turns the micro-ion gauge delay on or off.
void	setDelayTime(int time) Sets the micro-ion gauge delay time.
void	setFilament(TestGP390.Fmode mode) Sets the filament mode.
void	setGaugeOn(TestGP390.OnOff onoff) Turns the micro-ion gauge on or off.
void	setLock(TestGP390.OnOff onoff) Sets the protected settings lock.
void	setOffset(int offset) Sets the address offset.
void	setRelayTrip(int relay, TestGP390.TripType type, double value) Sets a trip relay set point.
void	setSwitchPressure(double press) Sets the micro-ion gauge switch pressure.
void	setTimeout(double timeout) Sets the response timeout.
void	setUnits(int baud) Sets the baud rate.
void	setUnits(TestGP390.Units units) Sets the pressure units.
String	showAtmospheric() Shows the atmospheric pressure.
String	showCurrent() Shows the micro-ion gauge current.
String	showDegas() Shows the micro-ion gauge degas state.
String	showDegasTime() Shows the micro-ion gauge degas time.
String	showDelay() Shows the micro-ion gauge delay state.
String	showDelayTime() Shows the micro-ion gauge delay time.
String	showFilament() Shows the filament status.
String	showFwVersion() Shows the firmware version.
String	showGauge() Shows the micro-ion gauge state.
String	showRelayAssign(int relay) Gets the vacuum type assignment for a trip relay.
String	showRelayTrip(int relay, TestGP390.TripType type) Shows a trip relay set point.
String	showStatusWord() Shows the status word.
String	showSwitchPressure() Shows the micro-ion gauge switch pressure.
String	showUnits() Shows the pressure units.
String	toggleLock() Toggles the protected settings lock.
void	unlock() Unlocks protected settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestGP390

public TestGP390()

Method Detail

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="type",description="Connection type")
                                                                                         GP390.ConnType connType,
                                                                                         @Argument(name="ident",description="Identification")
                                                                                         String ident,
                                                                                         @Argument(name="baud",description="Baud rate")
                                                                                         int baud,
                                                                                         @Argument(name="addr",description="Device address")
                                                                                         int address)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device.

Parameters:

connType - The type of connection: ftdi or serial

ident - The identification: serial no. (ftdi) or port name (serial)

baud - The baud rate

address - The address of the device

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

@Command(name="close",
         description="Close the connection")
public void close()
                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Closes the connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

unlock

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

Unlocks protected settings.

Throws:

org.lsst.ccs.drivers.commons.DriverException

toggleLock

@Command(name="toggle",
         description="Toggle protected settings lock")
public String toggleLock()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Toggles the protected settings lock.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLock

@Command(name="lock",
         description="Set protected settings lock")
public void setLock(@Argument(name="onoff",description="ON or OFF")
                                                                                              TestGP390.OnOff onoff)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the protected settings lock.

Parameters:

onoff - ON or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

@Command(name="reset",
         description="Reset to power-on state")
public void reset()
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Resets to power-on state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDefaults

@Command(name="setdefaults",
         description="Set factory defaults")
public void setDefaults()
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets values to factory defaults.

Throws:

org.lsst.ccs.drivers.commons.DriverException

showFwVersion

@Command(name="showversion",
         description="Show firmware version")
public String showFwVersion()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows the firmware version.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showStatusWord

@Command(name="showstatus",
         description="Show status word")
public String showStatusWord()
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Shows the status word.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setUnits

@Command(name="setunits",
         description="Set pressure units")
public void setUnits(@Argument(name="unit",description="Pressure units")
                                                                                          TestGP390.Units units)
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Sets the pressure units.

Parameters:

units -

Throws:

org.lsst.ccs.drivers.commons.DriverException

showUnits

@Command(name="showunits",
         description="Show pressure units")
public String showUnits()
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Shows the pressure units.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPressure

@Command(name="readvacuum",
         description="Read vacuum pressure")
public String readPressure()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Reads the vacuum pressure.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDiffPressure

@Command(name="readdiff",
         description="Read differential pressure")
public String readDiffPressure()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Reads the differential pressure.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAtmospheric

@Command(name="setatmospheric",
         description="Set atmospheric pressure")
public void setAtmospheric(@Argument(name="press",description="Atmospheric pressure")
                                                                                                            double press)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the atmospheric pressure.

Parameters:

press - The atmospheric pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

showAtmospheric

@Command(name="showatmospheric",
         description="Show atmospheric pressure")
public String showAtmospheric()
                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Shows the atmospheric pressure.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFilament

@Command(name="setfilament",
         description="Set filament mode")
public void setFilament(@Argument(name="mode",description="Filament mode")
                                                                                               TestGP390.Fmode mode)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the filament mode.

Parameters:

mode - The filament mode

Throws:

org.lsst.ccs.drivers.commons.DriverException

showFilament

@Command(name="showfilament",
         description="Show filament status")
public String showFilament()
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Shows the filament status.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setGaugeOn

@Command(name="setgauge",
         description="Set gauge on or off")
public void setGaugeOn(@Argument(name="onoff",description="ON or OFF")
                                                                                             TestGP390.OnOff onoff)
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Turns the micro-ion gauge on or off.

Parameters:

onoff - ON or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

showGauge

@Command(name="showgauge",
         description="Show gauge state")
public String showGauge()
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDegasOn

@Command(name="setdegas",
         description="Turn gauge degas on or off")
public void setDegasOn(@Argument(name="onoff",description="ON or OFF")
                                                                                                    TestGP390.OnOff onoff)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Turns the micro-ion gauge degas on or off.

Parameters:

onoff - ON or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

showDegas

@Command(name="showdegas",
         description="Show gauge degas state")
public String showDegas()
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge degas state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDegasTime

@Command(name="setdegastime",
         description="Set gauge degas time")
public void setDegasTime(@Argument(name="time",description="Degas time")
                                                                                                    int time)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the micro-ion gauge degas time.

Parameters:

time - Degas time (sec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

showDegasTime

@Command(name="showdegastime",
         description="Show degas time")
public String showDegasTime()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge degas time.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDelayOn

@Command(name="setdelay",
         description="Turn gauge delay on or off")
public void setDelayOn(@Argument(name="onoff",description="ON or OFF")
                                                                                                    TestGP390.OnOff onoff)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Turns the micro-ion gauge delay on or off.

Parameters:

onoff - ON or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

showDelay

@Command(name="showdelay",
         description="Show gauge delay state")
public String showDelay()
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge delay state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDelayTime

@Command(name="setdelaytime",
         description="Set gauge delay time")
public void setDelayTime(@Argument(name="time",description="Delay time")
                                                                                                    int time)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the micro-ion gauge delay time.

Parameters:

time - Delay time (sec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

showDelayTime

@Command(name="showdelaytime",
         description="Show gauge delay time")
public String showDelayTime()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge delay time.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSwitchPressure

@Command(name="setswitch",
         description="Set gauge switch pressure")
public void setSwitchPressure(@Argument(name="pressure",description="Switch pressure")
                                                                                                           double press)
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the micro-ion gauge switch pressure.

Parameters:

press - The switch pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

showSwitchPressure

@Command(name="showswitch",
         description="Show gauge switch pressure")
public String showSwitchPressure()
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the micro-ion gauge switch pressure.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrent

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

Shows the micro-ion gauge current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRelayTrip

@Command(name="setrelaytrip",
         description="Set relay trip point")
public void setRelayTrip(@Argument(name="relay",description="Relay number")
                                                                                                    int relay,
                                                                                                    @Argument(name="type",description="Set point type")
                                                                                                    TestGP390.TripType type,
                                                                                                    @Argument(name="value",description="Set point value")
                                                                                                    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: ACT or DEACT

value - The set point value

Throws:

org.lsst.ccs.drivers.commons.DriverException

showRelayTrip

@Command(name="showrelaytrip",
         description="Show relay trip point")
public String showRelayTrip(@Argument(name="relay",description="Relay number")
                                                                                                         int relay,
                                                                                                         @Argument(name="type",description="Set point type")
                                                                                                         TestGP390.TripType type)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Shows a trip relay set point.

Parameters:

relay - The relay number (1 - 3)

type - The set point type: ACT or DEACT

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

assignRelay

@Command(name="assignrelay",
         description="Assign relay to vacuum type")
public void assignRelay(@Argument(name="relay",description="Relay number")
                                                                                                         int relay,
                                                                                                         @Argument(name="type",description="Vacuum type")
                                                                                                         TestGP390.VacType type)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Assigns a trip relay to a vacuum type.

Parameters:

relay - The relay number (1 - 3)

type - The vacuum type: ABS or DIFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

showRelayAssign

@Command(name="showrelayassign",
         description="Show relay assignment type")
public String showRelayAssign(@Argument(name="relay",description="Relay number")
                                                                                                                  int relay)
                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Gets the vacuum type assignment for a trip relay.

Parameters:

relay - The relay number (1 - 3)

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableRelay

@Command(name="enablerelay",
         description="Enable a relay")
public void enableRelay(@Argument(name="relay",description="Relay number")
                                                                                            int relay,
                                                                                            @Argument(name="enable",description="Whether to enable")
                                                                                            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

@Command(name="isrelayenabled",
         description="Check whether relay enabled")
public String isRelayEnabled(@Argument(name="relay",description="Relay number")
                                                                                                                 int relay)
                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Shows whether a trip relay is enabled.

Parameters:

relay - The relay number (1 - 3)

Returns:

Whether enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayActive

@Command(name="isrelayactive",
         description="Check whether relay is active")
public String isRelayActive(@Argument(name="relay",description="Relay number")
                                                                                                                 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

setOffset

@Command(name="setoffset",
         description="Set address offset")
public void setOffset(@Argument(name="offset",description="Address first digit")
                                                                                            int offset)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the address offset.

Parameters:

offset - The first hex digit of the address

Throws:

org.lsst.ccs.drivers.commons.DriverException

setUnits

@Command(name="setbaud",
         description="Set baud rate")
public void setUnits(@Argument(name="unit",description="Baud rate")
                                                                                    int baud)
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the baud rate.

Parameters:

baud - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

@Command(name="settimeout",
         description="Set response timeout")
public void setTimeout(@Argument(name="timeout",description="Timeout (secs)")
                                                                                                double timeout)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Sets the response timeout.

Parameters:

timeout - The timeout (secs)

Throws:

org.lsst.ccs.drivers.commons.DriverException