org.lsst.ccs.drivers.twistorr

Class Test84

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.twistorr.Test84

public class Test84
extends org.lsst.ccs.drivers.ascii.TestAscii

Program to test the TwisTorr 84 turbo pump device driver.

Author:

Al Eisner

Field Summary

Fields inherited from class org.lsst.ccs.drivers.ascii.TestAscii

dev

Constructor Summary

Constructors

Constructor and Description
Test84() Constructor

Method Summary

Modifier and Type	Method and Description
void	closeVentValve() Close vent valve (in on-command mode, setVentOperation above)
void	enableSpeedRead(boolean value) Enable/disable pump-speed reading after Stop
void	open(String ident) Opens connection to a device.
void	openVentValve() Open vent valve (in on-command mode, setVentOperation above)
String	readActiveStop() Read active-stop setting
String	readAll() Read all settings and data from pump controller.
String	readBool(TwisTorr84.CmndBool quantity) Generic read command for boolean quantities
String	readErrorCode() Read error code (bits show reason for pump failure)
String	readNumeric(TwisTorr84.CmndNumeric quantity) Generic read command for numberic (integer) quantities
TwisTorr84.PumpStatus	readStatus() Read and decode pump status
String	readTemp() Read pump temperature
void	resetPumpHoursCyclesIRREVERSIBLE(boolean confirm) Reset pump lifetime and cycles
void	selectAnalog(int value) choice of programmable analog output
void	setActiveStop(boolean value) Select active stop (with braking) vs.
void	setBaudRate(int value) Select baud rate, 600 to 9600 (default)
void	setGasType(boolean value) Select gas load type
void	setInterlockType(boolean value) Set signal-type for interlock
void	setLowFreq(int value) Set low-speed roational frequency
void	setLowSpeedMode(boolean value) Select speed mode (low vs.
void	setpointDelay(int value) setpoint delay
void	setpointHyst(int value) setpoint hysteresis (for frequency, power, orpressure)
void	setpointLevel(boolean value) setpoint level
void	setpointType(int value) Commands related to programmable setpoint and analog output (on J1) /** setpoint type
void	setpointValue(int value) setpoint value (other than for pressure)
void	setRemote(boolean value) Select "Remote" (I/O) mode vs.
void	setRotFreq(int value) Set normal roational frequency
void	setSoftStart(boolean value) Select soft start vs.
void	setVentDelay(int value) Set vent-valve opening delay in automatic mode
void	setVentOpenTime(int value) Set vent-valve open time in automatic mode
void	setVentOperation(boolean value) Vent valve automatic or by command (openVentValve, closeVentValve)
void	setWaterCooling(boolean value) Set water cooling on or off
void	startPump() Start pump
void	stopPump() Stop pump
String	testErrorCode(int testcode) Test error code (bits show reason for pump failure)
String	timestamp() Determines current time

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

close, makeCommandString, open, open, open, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, read, read, setCmndTerm, setDefaultParm, setOptions, setRespTerm, setTerminator, setTimeout, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Test84

public Test84()

Constructor

Method Detail

timestamp

@Command(name="timestamp",
         description="Prints current time")
public String timestamp()

Determines current time

Returns:

current time as a String

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="ident",description="Identification")
                                                                                         String ident)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device.

Parameters:

ident - The identification (serial port name)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(name="readAll",
         description="Read all controller settings and data")
public String readAll()

Read all settings and data from pump controller. Loops over all read commands and returns them in a table format. All DriverExceptions are caught; if one occurs, the data field is replaced by the text (String) associated with the exception.

Returns:

String reporting all data read and exceptions.

readBool

@Command(name="readBool",
         description="Read specified boolean quantity")
public String readBool(@Argument(name="enum quantity",description="name of boolean quantity")
                                                                                                         TwisTorr84.CmndBool quantity)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Generic read command for boolean quantities

Parameters:

Enumerated - command name

Returns:

String showing response

Throws:

org.lsst.ccs.drivers.commons.DriverException

readNumeric

@Command(name="readNumeric",
         description="Read specified numeric quantity")
public String readNumeric(@Argument(name="enum quantity",description="name of numeric quantity")
                                                                                                               TwisTorr84.CmndNumeric quantity)
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Generic read command for numberic (integer) quantities

Parameters:

Enumerated - command name

Returns:

String showing response

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTemp

@Command(name="readTemp",
         description="Read pump temperature in degrees C")
public String readTemp()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Read pump temperature

Returns:

String showing pump temperature in degrees C

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

readActiveStop

@Command(name="readActiveStop",
         description="Read active-stop setting")
public String readActiveStop()
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Read active-stop setting

Returns:

String showing active-stop state

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

readStatus

@Command(name="readStatus",
         description="Get pump status, including operating modes and failure")
public TwisTorr84.PumpStatus readStatus()
                                                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Read and decode pump status

Returns:

String indicating pump state or failure

Throws:

org.lsst.ccs.drivers.commons.DriverException

readErrorCode

@Command(name="readErrorCode",
         description="Read pump error code")
public String readErrorCode()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Read error code (bits show reason for pump failure)

Returns:

String giving error code in hexadecimal and decoding

Throws:

org.lsst.ccs.drivers.commons.DriverException

testErrorCode

@Command(name="testErrorCode",
         description="Test decoding of error code")
public String testErrorCode(@Argument(name="testcode",description="code to test, 0 to 0xff")
                                                                                                               int testcode)

Test error code (bits show reason for pump failure)

Parameters:

Test - code (0 to 0xff) to be decoded

Returns:

String giving test code in hexadecimal and decoding

startPump

@Command(name="startPump",
         description="Start the pump")
public void startPump()
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Start pump

Throws:

org.lsst.ccs.drivers.commons.DriverException

stopPump

@Command(name="stopPump",
         description="Stop the pump")
public void stopPump()
                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Stop pump

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLowSpeedMode

@Command(name="setLowSpeedMode",
         description="Low-speed mode on/off")
public void setLowSpeedMode(@Argument(name="<true|false>",description="Low-speed mode true or false")
                                                                                                           boolean value)
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Select speed mode (low vs. normal)

Parameters:

value - True for low-speed mode, false for normal mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSoftStart

@Command(name="setSoftStart",
         description="Soft-start mode on/off")
public void setSoftStart(@Argument(name="<true|false>",description="Soft-start mode true or false")
                                                                                                      boolean value)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Select soft start vs. normal start

Parameters:

value - True for soft-start mode, false for normal mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setActiveStop

@Command(name="setActiveStop",
         description="Active-stop mode on/off")
public void setActiveStop(@Argument(name="<true|false>",description="Active-stop mode true or false")
                                                                                                         boolean value)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Select active stop (with braking) vs. normal stop mode

Parameters:

value - True for active-stop mode, false for normal-stop mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRemote

@Command(name="setRemote",
         description="Select remote vs. serial mode")
public void setRemote(@Argument(name="<true|false>",description="Remote I/O mode (true) vs. Serial mode (false)")
                                                                                                       boolean value)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Select "Remote" (I/O) mode vs. Serial mode for controller

Parameters:

value - True for remote mode, false for serial mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setWaterCooling

@Command(name="setWaterCooling",
         description="Water cooling on/off")
public void setWaterCooling(@Argument(name="<true|false>",description="Water cooling true or false")
                                                                                                          boolean value)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Set water cooling on or off

Parameters:

value - True/false for water cooling on/off

Throws:

org.lsst.ccs.drivers.commons.DriverException

setInterlockType

@Command(name="setInterlockType",
         description="Interlock signal continuos vs. impulse")
public void setInterlockType(@Argument(name="<true|false>",description="Continuous (true, default) or impulse (false)")
                                                                                                                              boolean value)
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Set signal-type for interlock

Parameters:

value - True/false for continuous signal / impulse signal

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableSpeedRead

@Command(name="enableSpeedRead",
         description="Enable/disable pump-speed read after Stop")
public void enableSpeedRead(@Argument(name="<true|false>",description="Enable (true) or disable(false, default)")
                                                                                                                               boolean value)
                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Enable/disable pump-speed reading after Stop

Parameters:

value - True/false for enable/disable

Throws:

org.lsst.ccs.drivers.commons.DriverException

setGasType

@Command(name="setGasType",
         description="Select gas load type")
public void setGasType(@Argument(name="<int>",description="false for N2, true for Ar")
                                                                                                boolean value)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Select gas load type

Parameters:

value - 0 for N, 1 for Ar

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBaudRate

@Command(name="setBaudRate",
         description="Select baud rate")
public void setBaudRate(@Argument(name="<int>",description="0 to 4 for 600, 1200, 2400, 4800, 9600 (default)")
                                                                                              int value)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Select baud rate, 600 to 9600 (default)

Parameters:

value - 0 to 4 for 600, 1200, 2400, 4800, 9600

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRotFreq

@Command(name="setRotFreq",
         description="Set rotational frequency")
public void setRotFreq(@Argument(name="<int>",description="1100 to 1350 (default) Hz")
                                                                                                    int value)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Set normal roational frequency

Parameters:

value - 1100 to 1350 (default)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setLowFreq

@Command(name="setLowFreq",
         description="Set low-speed rotational freq.")
public void setLowFreq(@Argument(name="<int>",description="1100 Hz (default) to normal freq.")
                                                                                                          int value)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Set low-speed roational frequency

Parameters:

value - 1100 (default) to normal frequency

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVentOperation

@Command(name="setVentOperation",
         description="Vent valve operation")
public void setVentOperation(@Argument(name="<true|false>",description="On-command (true) vs. Automatic (false, default)")
                                                                                                            boolean value)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Vent valve automatic or by command (openVentValve, closeVentValve)

Parameters:

value - True/false for on-command / automatic (default)

Throws:

org.lsst.ccs.drivers.commons.DriverException

openVentValve

@Command(name="openVentValve",
         description="Open vent valve")
public void openVentValve()
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Open vent valve (in on-command mode, setVentOperation above)

Throws:

org.lsst.ccs.drivers.commons.DriverException

closeVentValve

@Command(name="closeVentValve",
         description="Close vent valve")
public void closeVentValve()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Close vent valve (in on-command mode, setVentOperation above)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVentDelay

@Command(name="setVentDelay",
         description="Vent valve-open delay")
public void setVentDelay(@Argument(name="<int>",description="Opening delay after stop in auto mode, unit 0.2 s")
                                                                                                     int value)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Set vent-valve opening delay in automatic mode

Parameters:

value - Delay time in units of 0.2 sec

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVentOpenTime

@Command(name="setVentOpenTime",
         description="Vent valve-open time")
public void setVentOpenTime(@Argument(name="<int>",description="Open-time in automatic mode, unit 0.2 s, 0 for infinity")
                                                                                                          int value)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Set vent-valve open time in automatic mode

Parameters:

value - Time open in units of 0.2 sec or 0 for infinity

Throws:

org.lsst.ccs.drivers.commons.DriverException

setpointType

@Command(name="setpointType",
         description="Quantity for setpoint")
public void setpointType(@Argument(name="<int>",description="setpoint on frequency (0, default), power (1), time (2), normal (3), pressure (4)")
                                                                                                     int value)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Commands related to programmable setpoint and analog output (on J1) /** setpoint type

Parameters:

value - 0,1,2,3,4 for frequency, power, time, normal, pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

setpointValue

@Command(name="setpointValue",
         description="setpoint value")
public void setpointValue(@Argument(name="<int>",description="setpoint value in Hz, W or s (default = 867)")
                                                                                                int value)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

setpoint value (other than for pressure)

Parameters:

value - Value in hz, W or s

Throws:

org.lsst.ccs.drivers.commons.DriverException

setpointLevel

@Command(name="setpointLevel",
         description="setpoint active level")
public void setpointLevel(@Argument(name="<true|false>",description="Active on low-level (true, default) vs. high-level (false)")
                                                                                                       boolean value)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

setpoint level

Parameters:

value - Active on high level (false) or low-level (true)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setpointDelay

@Command(name="setpointDelay",
         description="setpoint-check delay")
public void setpointDelay(@Argument(name="<int>",description="Seconds after pump start (default 0)")
                                                                                                      int value)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

setpoint delay

Parameters:

value - Time (s) between pump start and setpoint check

Throws:

org.lsst.ccs.drivers.commons.DriverException

setpointHyst

@Command(name="setpointHyst",
         description="setpoint hysteresis")
public void setpointHyst(@Argument(name="<int>",description="Hysteresis in % of value (default = 2)")
                                                                                                   int value)
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

setpoint hysteresis (for frequency, power, orpressure)

Parameters:

value - In percent of setpoint value

Throws:

org.lsst.ccs.drivers.commons.DriverException

selectAnalog

@Command(name="selectAnalog",
         description="select analog output")
public void selectAnalog(@Argument(name="<int>",description="Select analog output (0 to 3, default = 0, frequency)")
                                                                                                    int value)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

choice of programmable analog output

Parameters:

value - 0 to 3 for frequency, power, pump temp., pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

resetPumpHoursCyclesIRREVERSIBLE

@Command(name="resetPumpHoursCyclesIRREVERSIBLE",
         description="resets pump total hours and count of cycles")
public void resetPumpHoursCyclesIRREVERSIBLE(@Argument(name="<true|false>",description="true to confirm command")
                                                                                                                                                                   boolean confirm)
                                                                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Reset pump lifetime and cycles

Parameters:

confirm - true to confirm user really wants to do this

Throws:

org.lsst.ccs.drivers.commons.DriverException