GP390 (LSST CCS - MKS Vacuum Gauge Driver 1.1.0 API)

java.lang.Object
- org.lsst.ccs.drivers.mks.GP390

```
public class GP390
extends Object
```
Routines for communicating with an MKS GP390 series vacuum gauge

Author:

Owen Saxton

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GP390.ConnType
Constants & data.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GP390.ConnType` Constants & data.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISP_ABS`
`static int`	`DISP_BOTH`
`static int`	`DISP_DIFF`
`static int`	`FMODE_ALT`
`static int`	`FMODE_AUTO`
`static int`	`FMODE_MAN`
`static int`	`GMODE_DEGAS`
`static int`	`GMODE_HIGH`
`static int`	`GMODE_LOW`
`static int`	`GMODE_OFF`
`static int`	`RELAY_ABS`
`static int`	`RELAY_ACT`
`static int`	`RELAY_DEACT`
`static int`	`RELAY_DIFF`
`static int`	`RELAY_MAX`
`static int`	`RELAY_MIN`
`static int`	`UNIT_MBAR`
`static int`	`UNIT_PA`
`static int`	`UNIT_TORR`

Constructor Summary

Constructors
Constructor and Description

GP390()

Constructors
Constructor and Description
`GP390()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignRelay(int relay, int assign)` Assigns a trip relay to a vacuum type.
`void`	`calibrateAtmospheric()` Calibrates at atmospheric pressure.
`void`	`calibrateVacuum()` Calibrates at vacuum pressure.
`void`	`close()` Closes the connection.
`void`	`enableRelay(int relay, boolean enable)` Enables/disables a trip relay.
`double`	`getAtmospheric()` Gets the atmospheric pressure.
`int`	`getFilamentStatus()` Gets the filament status.
`String`	`getFwVersion()` Gets the firmware version.
`int`	`getMiDegasTime()` Gets the micro-ion gauge degas time.
`int`	`getMiDelayTime()` Gets the micro-ion gauge delay time.
`double`	`getMiGaugeCurrent()` Gets the micro-ion gauge current.
`int`	`getMiGaugeMode()` Gets the micro-ion gauge mode.
`double`	`getMiSwitchPressure()` Gets the micro-ion current switch pressure.
`int`	`getPressureUnit()` Gets the pressure unit.
`int`	`getRelayAssignment(int relay)` Gets the assignment for a trip relay.
`double`	`getRelayTrip(int relay, int type)` Gets a trip relay set point.
`String[]`	`getStatusStrings()` Gets the array of status strings.
`int`	`getStatusWord()` Gets the status word.
`boolean`	`isMiDegasOn()` Tests whether a micro-ion gauge degas is on or off.
`boolean`	`isMiDelayOn()` Tests whether the micro-ion gauge delay is on or off.
`boolean`	`isMiGaugeOn()` Tests whether the micro-ion gauge is on or off.
`boolean`	`isPressureIndOn()` Tests whether the pressure indication is on or off.
`boolean`	`isRelayActive(int relay)` Gets whether a trip relay is active.
`boolean`	`isRelayEnabled(int relay)` Gets whether a trip relay is enabled.
`void`	`open(GP390.ConnType connType, String ident, int param, int address)` Opens a connection.
`double`	`readDiffPressure()` Reads the differential pressure.
`double`	`readPressure()` Reads the vacuum pressure.
`void`	`reset()` Resets to power-up state.
`void`	`setAddressOffset(int offset)` Sets the address offset.
`void`	`setAtmospheric(double press)` Sets the atmospheric pressure.
`void`	`setBaudRate(int baud)` Sets the baud rate.
`void`	`setCommDefaults()` Sets communications defaults.
`void`	`setDefaults()` Sets factory defaults.
`void`	`setFilamentMode(int mode)` Sets the filament mode.
`void`	`setLock(boolean on)` Sets the state of the protected function lock.
`void`	`setMiDegasOn(boolean on)` Turns a micro-ion gauge degas cycle on or off.
`void`	`setMiDegasTime(int time)` Sets the micro-ion gauge degas time.
`void`	`setMiDelayOn(boolean on)` Turns the micro-ion gauge delay on or off.
`void`	`setMiDelayTime(int time)` Sets the micro-ion gauge delay time.
`void`	`setMiGaugeOn(boolean on)` Turns the micro-ion gauge on or off.
`void`	`setMiSwitchPressure(double press)` Sets the micro-ion current switch pressure.
`void`	`setPressureDisp(int disp)` Sets the pressure display type.
`void`	`setPressureIndOn(boolean on)` Turns on or off the pressure indication when the micro-ion gauge is off.
`void`	`setPressureUnit(int unit)` Sets the pressure unit.
`void`	`setRelayTrip(int relay, int type, double value)` Sets a trip relay set point.
`void`	`setTimeout(double timeout)` Sets the read timeout.
`boolean`	`toggleLock()` Toggles protected function lock.
`void`	`unlock()` Unlocks protected functions (one time).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - UNIT_TORR
```
public static final int UNIT_TORR
```
    See Also:
    
    Constant Field Values
  - UNIT_MBAR
```
public static final int UNIT_MBAR
```
    See Also:
    
    Constant Field Values
  - UNIT_PA
```
public static final int UNIT_PA
```
    See Also:
    
    Constant Field Values
  - DISP_ABS
```
public static final int DISP_ABS
```
    See Also:
    
    Constant Field Values
  - DISP_DIFF
```
public static final int DISP_DIFF
```
    See Also:
    
    Constant Field Values
  - DISP_BOTH
```
public static final int DISP_BOTH
```
    See Also:
    
    Constant Field Values
  - FMODE_MAN
```
public static final int FMODE_MAN
```
    See Also:
    
    Constant Field Values
  - FMODE_ALT
```
public static final int FMODE_ALT
```
    See Also:
    
    Constant Field Values
  - FMODE_AUTO
```
public static final int FMODE_AUTO
```
    See Also:
    
    Constant Field Values
  - GMODE_OFF
```
public static final int GMODE_OFF
```
    See Also:
    
    Constant Field Values
  - GMODE_DEGAS
```
public static final int GMODE_DEGAS
```
    See Also:
    
    Constant Field Values
  - GMODE_HIGH
```
public static final int GMODE_HIGH
```
    See Also:
    
    Constant Field Values
  - GMODE_LOW
```
public static final int GMODE_LOW
```
    See Also:
    
    Constant Field Values
  - RELAY_MIN
```
public static final int RELAY_MIN
```
    See Also:
    
    Constant Field Values
  - RELAY_MAX
```
public static final int RELAY_MAX
```
    See Also:
    
    Constant Field Values
  - RELAY_ABS
```
public static final int RELAY_ABS
```
    See Also:
    
    Constant Field Values
  - RELAY_DIFF
```
public static final int RELAY_DIFF
```
    See Also:
    
    Constant Field Values
  - RELAY_ACT
```
public static final int RELAY_ACT
```
    See Also:
    
    Constant Field Values
  - RELAY_DEACT
```
public static final int RELAY_DEACT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GP390
```
public GP390()
```
- Method Detail
  - open
```
public void open(GP390.ConnType connType,
                 String ident,
                 int param,
                 int address)
          throws org.lsst.ccs.drivers.commons.DriverException
```
    Opens a connection.
    
    Parameters:
    
    connType - The connection type (FTDI or SERIAL)
    
    ident - The identification (USB S/N or port)
    
    param - The parameter (baud rate)
    
    address - The device address
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - close
```
public void close()
           throws org.lsst.ccs.drivers.commons.DriverException
```
    Closes the connection.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setTimeout
```
public void setTimeout(double timeout)
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the read timeout.
    
    Parameters:
    
    timeout - The timeout (secs). 0 means no timeout.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setPressureUnit
```
public void setPressureUnit(int unit)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the pressure unit.
    
    Parameters:
    
    unit - The pressure unit: TORR, MBAR or PA
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getPressureUnit
```
public int getPressureUnit()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the pressure unit.
    
    Returns:
    
    The pressure unit
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setPressureDisp
```
public void setPressureDisp(int disp)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the pressure display type.
    
    Parameters:
    
    disp - The pressure display type: ABS, DIFF or BOTH
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readPressure
```
public double readPressure()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the vacuum pressure.
    
    Returns:
    
    The pressure
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readDiffPressure
```
public double readDiffPressure()
                        throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the differential pressure.
    
    Returns:
    
    The pressure
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - toggleLock
```
public boolean toggleLock()
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Toggles protected function lock.
    
    Returns:
    
    Whether functions are locked
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setLock
```
public void setLock(boolean on)
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the state of the protected function lock.
    
    Parameters:
    
    on - Whether lock is to be set on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - unlock
```
public void unlock()
            throws org.lsst.ccs.drivers.commons.DriverException
```
    Unlocks protected functions (one time).
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setAddressOffset
```
public void setAddressOffset(int offset)
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the address offset.
    
    Parameters:
    
    offset - The first hex digit of the address: 0 - 3
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setBaudRate
```
public void setBaudRate(int baud)
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the baud rate.
    
    Parameters:
    
    baud - The baud rate: 1200, 2400, 4800, 9600, 19200 or 38400
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setFilamentMode
```
public void setFilamentMode(int mode)
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the filament mode.
    
    Parameters:
    
    mode - The filament mode: MAN, ALT or AUTO
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getFilamentStatus
```
public int getFilamentStatus()
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the filament status.
    
    Returns:
    
    Which filament(s) are on: 1, 2 or 3 (both)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiGaugeOn
```
public void setMiGaugeOn(boolean on)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns the micro-ion gauge on or off.
    
    Parameters:
    
    on - Whether to turn the gauge on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - isMiGaugeOn
```
public boolean isMiGaugeOn()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Tests whether the micro-ion gauge is on or off.
    
    Returns:
    
    Whether the gauge is on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setPressureIndOn
```
public void setPressureIndOn(boolean on)
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns on or off the pressure indication when the micro-ion gauge is off.
    
    Parameters:
    
    on - Whether to turn the pressure indication on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - isPressureIndOn
```
public boolean isPressureIndOn()
                        throws org.lsst.ccs.drivers.commons.DriverException
```
    Tests whether the pressure indication is on or off.
    
    Returns:
    
    Whether the pressure indication is on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiDelayOn
```
public void setMiDelayOn(boolean on)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns the micro-ion gauge delay on or off.
    
    Parameters:
    
    on - Whether to turn the gauge delay on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - isMiDelayOn
```
public boolean isMiDelayOn()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Tests whether the micro-ion gauge delay is on or off.
    
    Returns:
    
    Whether the gauge delay is on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiDelayTime
```
public void setMiDelayTime(int time)
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the micro-ion gauge delay time.
    
    Parameters:
    
    time - The degas time (0 - 600 secs)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getMiDelayTime
```
public int getMiDelayTime()
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the micro-ion gauge delay time.
    
    Returns:
    
    The degas time
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiDegasOn
```
public void setMiDegasOn(boolean on)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns a micro-ion gauge degas cycle on or off.
    
    Parameters:
    
    on - Whether to turn the gauge degas on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - isMiDegasOn
```
public boolean isMiDegasOn()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Tests whether a micro-ion gauge degas is on or off.
    
    Returns:
    
    Whether the gauge degas is on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiDegasTime
```
public void setMiDegasTime(int time)
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the micro-ion gauge degas time.
    
    Parameters:
    
    time - The degas time (10 - 120 secs)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getMiDegasTime
```
public int getMiDegasTime()
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the micro-ion gauge degas time.
    
    Returns:
    
    The degas time
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setMiSwitchPressure
```
public void setMiSwitchPressure(double press)
                         throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the micro-ion current switch pressure.
    
    Parameters:
    
    press - The switch pressure
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getMiSwitchPressure
```
public double getMiSwitchPressure()
                           throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the micro-ion current switch pressure.
    
    Returns:
    
    The switch pressure
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getMiGaugeCurrent
```
public double getMiGaugeCurrent()
                         throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the micro-ion gauge current.
    
    Returns:
    
    The gauge current (mA)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getMiGaugeMode
```
public int getMiGaugeMode()
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the micro-ion gauge mode.
    
    Returns:
    
    The gauge mode (OFF, DEGAS, HIGH or LOW)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - calibrateAtmospheric
```
public void calibrateAtmospheric()
                          throws org.lsst.ccs.drivers.commons.DriverException
```
    Calibrates at atmospheric pressure.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - calibrateVacuum
```
public void calibrateVacuum()
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Calibrates at vacuum pressure.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setAtmospheric
```
public void setAtmospheric(double press)
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the atmospheric pressure.
    
    Parameters:
    
    press - The atmospheric pressure value to set, or negative for actual
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getAtmospheric
```
public double getAtmospheric()
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the atmospheric pressure.
    
    Returns:
    
    The atmospheric pressure or -1.0 for actual
    
    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
  - getStatusStrings
```
public String[] getStatusStrings()
                          throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the array of status strings.
    
    Returns:
    
    The status strings
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getStatusWord
```
public int getStatusWord()
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the status word.
    
    Returns:
    
    The status word
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getFwVersion
```
public String getFwVersion()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the firmware version.
    
    Returns:
    
    The firmware version
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - reset
```
public void reset()
           throws org.lsst.ccs.drivers.commons.DriverException
```
    Resets to power-up state.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setCommDefaults
```
public void setCommDefaults()
                     throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets communications defaults.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setDefaults
```
public void setDefaults()
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets factory defaults.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException

Class GP390

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNIT_TORR

UNIT_MBAR

UNIT_PA

DISP_ABS

DISP_DIFF

DISP_BOTH

FMODE_MAN

FMODE_ALT

FMODE_AUTO

GMODE_OFF

GMODE_DEGAS

GMODE_HIGH

GMODE_LOW

RELAY_MIN

RELAY_MAX

RELAY_ABS

RELAY_DIFF

RELAY_ACT

RELAY_DEACT

Constructor Detail

GP390

Method Detail

open

close

setTimeout

setPressureUnit

getPressureUnit

setPressureDisp

readPressure

readDiffPressure

toggleLock

setLock

unlock

setAddressOffset

setBaudRate

setFilamentMode

getFilamentStatus

setMiGaugeOn

isMiGaugeOn

setPressureIndOn

isPressureIndOn

setMiDelayOn

isMiDelayOn

setMiDelayTime

getMiDelayTime

setMiDegasOn

isMiDegasOn

setMiDegasTime

getMiDegasTime

setMiSwitchPressure

getMiSwitchPressure

getMiGaugeCurrent

getMiGaugeMode

calibrateAtmospheric

calibrateVacuum

setAtmospheric

getAtmospheric

setRelayTrip

getRelayTrip

assignRelay

getRelayAssignment

enableRelay

isRelayEnabled

isRelayActive

getStatusStrings

getStatusWord

getFwVersion

reset

setCommDefaults

setDefaults