org.lsst.ccs.drivers.twistorr

Class TwisTorr84

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.twistorr.TwisTorr84

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class TwisTorr84
extends org.lsst.ccs.drivers.ascii.Ascii

Driver for Agilent TwisTorr 84 FS AG turbopump Navigator Controller (models X3509-64000, X3509-64001) Only the RS-232 (as opposed to RS-485) option is supported.

Author:

Al Eisner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TwisTorr84.CmndAlpha Enumeration of controller commands with Alphanumeric data
static class	TwisTorr84.CmndBool Enumeration of controller commands with Logical (boolean) data
static class	TwisTorr84.CmndNumeric Enumeration of controller commands with Numeric (int) data
static class	TwisTorr84.ConResp Enumeration of single-byte acknowledgement or error responses
static class	TwisTorr84.PumpStatus Enumeration of pump status codes (returned by Read, window 205)

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

Constructor Summary

Constructors

Constructor and Description
TwisTorr84() Constructor.

Method Summary

Modifier and Type	Method and Description
static String	decodeError(int errcode) Decode error bit-pattern of reason(s) for pump status = FAIL
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int baudRate, int commParm) Override underlying open method of Ascii class
void	open(String serialName) Open serial connection using default data characteristics
String	readAlpha(TwisTorr84.CmndAlpha cmnd) Read Alphanumeric data
boolean	readBool(TwisTorr84.CmndBool cmnd) Read Logical (boolean) data
int	readNumeric(TwisTorr84.CmndNumeric cmnd) Read Numeric (int) data
void	writeAlpha(TwisTorr84.CmndAlpha cmnd, String adata) Write Alphanumeric data
void	writeBool(TwisTorr84.CmndBool cmnd, boolean bdata) Write Logical (boolean) data
void	writeNumeric(TwisTorr84.CmndNumeric cmnd, int ndata) Write Numeric (int) data

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

close, closeSilent, flush, getTimeout, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, 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

TwisTorr84

public TwisTorr84()

Constructor.

Method Detail

decodeError

public static String decodeError(int errcode)

Decode error bit-pattern of reason(s) for pump status = FAIL

open

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

Override underlying open method of Ascii class

Overrides:

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

Parameters:

connType - The enumerated connection type: FTDI or SERIAL

ident - The USB ID (FTDI) or port name (SERIAL)

baudRate - The baud rate, or 0 for the default (9600)

commParm - The communications parameters (ignored, 0 used)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Open serial connection using default data characteristics

Parameters:

serialName - Serial device name

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBool

public boolean readBool(TwisTorr84.CmndBool cmnd)
                 throws org.lsst.ccs.drivers.commons.DriverException

Read Logical (boolean) data

Parameters:

cmnd - enumerated command identifier

Returns:

data returned from controller

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeBool

public void writeBool(TwisTorr84.CmndBool cmnd,
                      boolean bdata)
               throws org.lsst.ccs.drivers.commons.DriverException

Write Logical (boolean) data

Parameters:

cmnd - enumerated command identifier

bdata - boolean data to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

readNumeric

public int readNumeric(TwisTorr84.CmndNumeric cmnd)
                throws org.lsst.ccs.drivers.commons.DriverException

Read Numeric (int) data

Parameters:

cmnd - enumerated command identifier

Returns:

data returned from controller

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeNumeric

public void writeNumeric(TwisTorr84.CmndNumeric cmnd,
                         int ndata)
                  throws org.lsst.ccs.drivers.commons.DriverException

Write Numeric (int) data

Parameters:

cmnd - enumerated command identifier

ndata - integer data to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAlpha

public String readAlpha(TwisTorr84.CmndAlpha cmnd)
                 throws org.lsst.ccs.drivers.commons.DriverException

Read Alphanumeric data

Parameters:

cmnd - enumerated command identifier

Returns:

data returned from controller

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeAlpha

public void writeAlpha(TwisTorr84.CmndAlpha cmnd,
                       String adata)
                throws org.lsst.ccs.drivers.commons.DriverException

Write Alphanumeric data

Parameters:

cmnd - enumerated command identifier

adata - alphanumeric (String) data to write

Throws:

org.lsst.ccs.drivers.commons.DriverException