TPG361 (LSST CCS - Pfeiffer Drivers 3.0.1 API)

java.lang.Object
- org.lsst.ccs.drivers.ascii.Ascii
- - org.lsst.ccs.drivers.pfeiffer.TPG361

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants
```
public class TPG361
extends org.lsst.ccs.drivers.ascii.Ascii
```
General access routines for the Pfeiffer TPG361/362 Vacuum Gauge Controller

Author:

Owen Saxton

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TPG361.GaugeStatus

static class TPG361.Unit
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`TPG361.GaugeStatus`
`static class`	`TPG361.Unit`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEV_INFO_FW_VER` Public constants
`static int`	`DEV_INFO_HW_VER` Public constants
`static int`	`DEV_INFO_MODEL` Public constants
`static int`	`DEV_INFO_SERIAL` Public constants
`static int`	`DEV_INFO_TYPE` Public constants
`static int`	`NUM_DEV_INFO` Public constants

Constructor Summary

Constructors
Constructor and Description

TPG361()
Constructor

Constructors
Constructor and Description
`TPG361()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearInput()` Clears the input buffer.
`void`	`gaugeOff()` Turns the first (or only) gauge off.
`void`	`gaugeOff(int gauge)` Turns a gauge off.
`void`	`gaugeOn()` Turns the first (or only) gauge on.
`void`	`gaugeOn(int gauge)` Turns a gauge on.
`String[]`	`getDeviceInfo()` Gets device information.
`String`	`getError()` Gets the error status.
`String`	`getGaugeID()` Gets the ID of the first (or only) gauge.
`String`	`getGaugeID(int gauge)` Gets the ID of a gauge.
`TPG361.GaugeStatus`	`getGaugeStatus()` Gets the status of the first (or only) gauge.
`TPG361.GaugeStatus`	`getGaugeStatus(int gauge)` Gets the status of a gauge.
`int`	`getOperatingHours()` Gets the operating hours.
`TPG361.Unit`	`getUnit()` Gets the pressure unit.
`void`	`open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int parm1, int parm2)` Opens a connection.
`double[]`	`readPressure()` Reads the pressure from the first (or only) gauge.
`double[]`	`readPressure(int gauge)` Reads the pressure from a gauge.
`String`	`readResponse()` Reads a response.
`String`	`readString(String command)` Sends a command and gets the response.
`double`	`readTemperature()` Reads the temperature.
`void`	`setUnit(TPG361.Unit unit)` Sets the pressure unit.
`void`	`writeCommand(String command)` Writes a command and checks for error.

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, setDefaultBaud, setDefaultParm, setDefaultPort, 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

- Field Detail
  - DEV_INFO_TYPE
```
public static final int DEV_INFO_TYPE
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DEV_INFO_MODEL
```
public static final int DEV_INFO_MODEL
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DEV_INFO_SERIAL
```
public static final int DEV_INFO_SERIAL
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DEV_INFO_FW_VER
```
public static final int DEV_INFO_FW_VER
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - DEV_INFO_HW_VER
```
public static final int DEV_INFO_HW_VER
```
    Public constants
    
    See Also:
    
    Constant Field Values
  - NUM_DEV_INFO
```
public static final int NUM_DEV_INFO
```
    Public constants
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TPG361
```
public TPG361()
```
    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. This is the main open method and overrides the Ascii one, adding additional functionality
    
    Overrides:
    
    open in class org.lsst.ccs.drivers.ascii.Ascii
    
    Parameters:
    
    connType - The connection type
    
    ident - The device identifier
    
    parm1 - The first parameter
    
    parm2 - The second parameter
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getDeviceInfo
```
public String[] getDeviceInfo()
                       throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets device information.
    
    Returns:
    
    A 5-element string array of information
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getGaugeID
```
public String getGaugeID()
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the ID of the first (or only) gauge.
    
    Returns:
    
    The ID string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getGaugeID
```
public String getGaugeID(int gauge)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the ID of a gauge.
    
    Parameters:
    
    gauge - The gauge number (0 or 1)
    
    Returns:
    
    The ID string: TPR/PCR (Pirani Gauge or Pirani Capacitive gauge) IKR (Cold Cathode Gauge 10^-9 & 10^-11) PKR (FullRange CC Gauge) PBR (FullRange BA Gauge) IMR (Pirani / High Pressure Gauge) CMR/APR (Linear gauge) noSEn (no SEnsor) noid (no identifier)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setUnit
```
public void setUnit(TPG361.Unit unit)
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the pressure unit.
    
    Parameters:
    
    unit - The pressure unit
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getUnit
```
public TPG361.Unit getUnit()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the pressure unit.
    
    Returns:
    
    The pressure unit
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getError
```
public String getError()
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the error status.
    
    Returns:
    
    The error string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - gaugeOn
```
public void gaugeOn()
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns the first (or only) gauge on.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - gaugeOn
```
public void gaugeOn(int gauge)
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns a gauge on.
    
    Parameters:
    
    gauge - The gauge number (0 or 1)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - gaugeOff
```
public void gaugeOff()
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns the first (or only) gauge off.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - gaugeOff
```
public void gaugeOff(int gauge)
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Turns a gauge off.
    
    Parameters:
    
    gauge - The gauge number (0 or 1)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getGaugeStatus
```
public TPG361.GaugeStatus getGaugeStatus()
                                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the status of the first (or only) gauge.
    
    Returns:
    
    The status value
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getGaugeStatus
```
public TPG361.GaugeStatus getGaugeStatus(int gauge)
                                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the status of a gauge.
    
    Parameters:
    
    gauge - The gauge number (0 or 1)
    
    Returns:
    
    The status enum: ABSENT, OFF or ON
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readPressure
```
public double[] readPressure()
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the pressure from the first (or only) gauge.
    
    Returns:
    
    The two-element pressure array
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readPressure
```
public double[] readPressure(int gauge)
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the pressure from a gauge.
    
    Parameters:
    
    gauge - The gauge number (0 or 1)
    
    Returns:
    
    A two-element array containing the pressure (in current units) [0] and the status [1]: 0: Measurement data okay 1: Under range 2: Over range 3: Sensor error 4: Sensor off (IKR, PKR, IMR, PBR) 5: No sensor (output: 5,2.0000E-2 [mbar]) 6: Identification error
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readTemperature
```
public double readTemperature()
                       throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads the temperature.
    
    Returns:
    
    The temperature (C)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getOperatingHours
```
public int getOperatingHours()
                      throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the operating hours.
    
    Returns:
    
    The number of hours of operation
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - writeCommand
```
public void writeCommand(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Writes a command and checks for error. Send a command and wait for its acknowledgment Transmit: command + CR Receive : (ACK or NAK) + CRLF
    
    Parameters:
    
    command - The command
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readResponse
```
public String readResponse()
                    throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads a response. Transmit: ENQ Receive: reply + CRLF
    
    Returns:
    
    The response string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readString
```
public String readString(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Sends a command and gets the response.
    
    Parameters:
    
    command - The command string
    
    Returns:
    
    The response string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - clearInput
```
public void clearInput()
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Clears the input buffer. Transmit: ETX
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException

Class TPG361

Nested Class Summary

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

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.commons.DriverConstants

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DEV_INFO_TYPE

DEV_INFO_MODEL

DEV_INFO_SERIAL

DEV_INFO_FW_VER

DEV_INFO_HW_VER

NUM_DEV_INFO

Constructor Detail

TPG361

Method Detail

open

getDeviceInfo

getGaugeID

getGaugeID

setUnit

getUnit

getError

gaugeOn

gaugeOn

gaugeOff

gaugeOff

getGaugeStatus

getGaugeStatus

readPressure

readPressure

readTemperature

getOperatingHours

writeCommand

readResponse

readString

clearInput