TPG261 (LSST CCS - Pfeiffer Drivers 2.0.1 API)

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

All Implemented Interfaces:

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

Author:

Peter Doherty

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TPG261.onOff
Public constants
- 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`	`TPG261.onOff` Public constants

Constructor Summary

Constructors
Constructor and Description

TPG261()

Constructors
Constructor and Description
`TPG261()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the connection.
`void`	`gaugeOff(Integer gauge)` Turn a TPG261 gauge off Transmit: SEN [,x,x] [] \| \| ? * \| \| - Gauge 2 Status \| \|---- Gauge 1 Status x = 0 ?> No status change 1 ?> Turn gauge off 2 ?> Turn gauge on
`void`	`gaugeOn(Integer gauge)` Turn a TPG261 gauge on Transmit: SEN [,x,x] [] \| \| ? * \| \| - Gauge 2 Status \| \|---- Gauge 1 Status x = 0 ?> No status change 1 ?> Turn gauge off 2 ?> Turn gauge on
`String`	`getError()` Get the TPG261 error status Transmit: ERR [] Receive: Transmit: Receive: xxxx ?? xxxx = 0000 ?> No error 1000 ?> Controller error 0100 ?> NO HWR No hardware 0010 ?> PAR Inadmissible parameter 0001 ?> SYN Syntax error
`String`	`getID()` Get the TPG261 ID Transmit: TID [] Receive : Transmit: Receive : x,x \| \| \| - Identification gauge 2 --- Identification gauge 2 x = TPR (Pirani Gauge or Pirani Capacitive gauge 1)) IKR9 (Cold Cathode Gauge 10-9) IKR11 (Cold Cathode Gauge 10-11) PKR (FullRange CC Gauge) PBR (FullRange BA Gauge) IMR (Pirani / High Pressure Gauge) CMR (Linear gauge) noSEn (no SEnsor) noid (no identifier)
`double`	`getPressure()` Gets the TPG261 pressure reading from gauge #1 (the only one we have).
`String`	`getReply(String command)` getReply(String command) Send a command, and wait for a reply.
`String`	`getStatus()` Get the TPG261 status Transmit: SEN [] Receive : Transmit: Receive : x,x ? ? ? ?? Status gauge 2 ?? Status gauge 1 x = 0 ?> Gauge cannot be turned on/off 1 ?> Gauge turned off 2 ?> Gauge turned on
`void`	`init()`
`void`	`open(String serialname, int port)` Opens a connection.
`void`	`openftdi(String serialname, int port)` Opens an FTDI connection.
`String`	`readTPG261()` Reads a response.
`String`	`readTPG261(String command)` Reads a response after writing a command.
`void`	`sendCommand(String command)` sendCommand(String command) Send a command, but do not wait for a reply other than to check for the acknowledgment of that command Transmit: command [] Receive : 0x6
`void`	`setTimeout(int timeout)` Sets the receive timeout.
`void`	`writeTPG261(String command)` Writes a command.

Methods inherited from class org.lsst.ccs.drivers.ascii.Ascii
closeSilent, flush, getTimeout, isOpen, makeDataCharacteristics, open, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setDefaultParm, setMultidrop, setOptions, setResponseTerm, setTerminator, setTimeout, write, writeBytes, writeBytes

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

- Constructor Detail
  - TPG261
```
public TPG261()
```
- Method Detail
  - open
```
public void open(String serialname,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException
```
    Opens a connection.
    
    Parameters:
    
    device - The device name of the serial port
    
    serialname -
    
    port -
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - openftdi
```
public void openftdi(String serialname,
                     int port)
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Opens an FTDI connection.
    
    Parameters:
    
    serialname -
    
    port -
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - init
```
public void init()
          throws org.lsst.ccs.drivers.commons.DriverException
```
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - close
```
public void close()
           throws org.lsst.ccs.drivers.commons.DriverException
```
    Closes the connection.
    
    Overrides:
    
    close in class org.lsst.ccs.drivers.ascii.Ascii
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getID
```
public String getID()
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Get the TPG261 ID Transmit: TID [] Receive : Transmit: Receive : x,x | | | - Identification gauge 2 --- Identification gauge 2 x = TPR (Pirani Gauge or Pirani Capacitive gauge 1)) IKR9 (Cold Cathode Gauge 10-9) IKR11 (Cold Cathode Gauge 10-11) PKR (FullRange CC Gauge) PBR (FullRange BA Gauge) IMR (Pirani / High Pressure Gauge) CMR (Linear gauge) noSEn (no SEnsor) noid (no identifier)
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getError
```
public String getError()
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Get the TPG261 error status Transmit: ERR [] Receive: Transmit: Receive: xxxx ?? xxxx = 0000 ?> No error 1000 ?> Controller error 0100 ?> NO HWR No hardware 0010 ?> PAR Inadmissible parameter 0001 ?> SYN Syntax error
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getStatus
```
public String getStatus()
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    Get the TPG261 status Transmit: SEN [] Receive : Transmit: Receive : x,x ? ? ? ?? Status gauge 2 ?? Status gauge 1 x = 0 ?> Gauge cannot be turned on/off 1 ?> Gauge turned off 2 ?> Gauge turned on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getPressure
```
public double getPressure()
                   throws org.lsst.ccs.drivers.commons.DriverException
```
    Gets the TPG261 pressure reading from gauge #1 (the only one we have). Transmit: PR1 [] Receive : (0x6,0xD,0xA) Transmit: (0x5) Receive : x,sx.xxxxEsxx _ ___________ ? ? ? ?? Measurement value ? [in current pressure unit] ? ?? Status, x = 0 ?> Measurement data okay 1 ?> Underrange 2 ?> Overrange 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
  - gaugeOn
```
public void gaugeOn(Integer gauge)
             throws org.lsst.ccs.drivers.commons.DriverException
```
    Turn a TPG261 gauge on Transmit: SEN [,x,x] [] | | ? * | | - Gauge 2 Status | |---- Gauge 1 Status x = 0 ?> No status change 1 ?> Turn gauge off 2 ?> Turn gauge on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - gaugeOff
```
public void gaugeOff(Integer gauge)
              throws org.lsst.ccs.drivers.commons.DriverException
```
    Turn a TPG261 gauge off Transmit: SEN [,x,x] [] | | ? * | | - Gauge 2 Status | |---- Gauge 1 Status x = 0 ?> No status change 1 ?> Turn gauge off 2 ?> Turn gauge on
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - sendCommand
```
public void sendCommand(String command)
                 throws org.lsst.ccs.drivers.commons.DriverException
```
    sendCommand(String command) Send a command, but do not wait for a reply other than to check for the acknowledgment of that command Transmit: command [] Receive : 0x6
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - getReply
```
public String getReply(String command)
                throws org.lsst.ccs.drivers.commons.DriverException
```
    getReply(String command) Send a command, and wait for a reply. Return reply String Transmit: command [] Receive : 0x6 Transmit: 0x5 Receive : reply
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - setTimeout
```
public void setTimeout(int timeout)
                throws org.lsst.ccs.drivers.commons.DriverException
```
    Sets the receive timeout.
    
    Overrides:
    
    setTimeout in class org.lsst.ccs.drivers.ascii.Ascii
    
    Parameters:
    
    timeout - The receive timeout (ms). 0 means no timeout.
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - writeTPG261
```
public void writeTPG261(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
  - readTPG261
```
public String readTPG261()
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads a response.
    
    Returns:
    
    The command response string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException
  - readTPG261
```
public String readTPG261(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException
```
    Reads a response after writing a command.
    
    Parameters:
    
    command - The command to write, excluding terminator
    
    Returns:
    
    The command response string
    
    Throws:
    
    org.lsst.ccs.drivers.commons.DriverException

Class TPG261

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

TPG261

Method Detail

open

openftdi

init

close

getID

getError

getStatus

getPressure

gaugeOn

gaugeOff

sendCommand

getReply

setTimeout

writeTPG261

readTPG261

readTPG261