org.lsst.ccs.subsystem.common.devices.turbopump

Class TwisTorr84Device

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.common.devices.turbopump.TwisTorr84Device

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

public class TwisTorr84Device
extends org.lsst.ccs.monitor.Device

Interfaces with driver for Agilent TwisTorr84 turbo pump. The Channels read are TurboPump driver/hardware quantities. The groovy Channel type identifies whether a quantity to be read is of type logical ("Bool"), integer ("Numeric") or alphanumeric ("Alpha"). The subtype identifies the specific quantity tto be read.

Author:

Al Eisner

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	activeStopMode
protected String	devcId
protected Boolean	interlockType
protected Boolean	lowSpeedMode
protected Boolean	model304
protected String	path Data fields.
protected Boolean	softStartMode
protected Boolean	ventValveByCmnd
protected Boolean	waterCooling

Fields inherited from class org.lsst.ccs.monitor.Device

alertOfflineId, configService, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, s

Constructor Summary

Constructors

Constructor and Description
TwisTorr84Device()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(org.lsst.ccs.monitor.Channel ch) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
TurboState	getTurboState() Get the current TurboState
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
String	readAll() Read all settings and data from pump controller.
protected double	readChannel(org.lsst.ccs.monitor.Channel ch) Reads a channel.
String	readTurboFailCode() Read error code (bits show reason for pump failure)
String	readTurboLife() Read TurboPump running-time in hours
org.lsst.ccs.drivers.twistorr.TwisTorr84.PumpStatus	readTurboStatus() Read and decode pump status
void	setActiveStopMode(Boolean value) Select active stop (with braking) vs.
void	setSoftStartMode(Boolean value) Select soft start vs.
void	startTurboPump() Start pump
void	stopTurboPump() Stop pump

Methods inherited from class org.lsst.ccs.monitor.Device

addLine, checkChannel, checkHwLine, checkLine, checkTimeout, configure, disable, dropChannel, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getGroupForChannel, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initChannel, initSensors, isEnabled, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelGroup, readChannelNow, setDisabled, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, start, testOnline

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown

Field Detail

path

@LookupPath
protected String path

Data fields.

devcId

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="serial port")
protected volatile String devcId

model304

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="true/false for model 304/84 pump")
protected volatile Boolean model304

lowSpeedMode

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="true/false for low/normal speed")
protected volatile Boolean lowSpeedMode

waterCooling

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="true/false for water/air cooling")
protected volatile Boolean waterCooling

ventValveByCmnd

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="true/false for manual/auto")
protected volatile Boolean ventValveByCmnd

interlockType

@ConfigurationParameter(isFinal=true,
                        units="unitless",
                        description="true/false for continuous/impulse")
protected volatile Boolean interlockType

softStartMode

@ConfigurationParameter(description="Soft-Start mode <true|false>, settable only if pump is stopped",
                        units="unitless")
protected volatile Boolean softStartMode

activeStopMode

@ConfigurationParameter(description="Active-Stop mode <true|false>, settable only if pump is stopped",
                        units="unitless")
protected volatile Boolean activeStopMode

Constructor Detail

TwisTorr84Device

public TwisTorr84Device()

Method Detail

initDevice

protected void initDevice()

Performs basic initialization. Verify that all ConfigurationParameters are set.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Performs full initialization.

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

setSoftStartMode

@ConfigurationParameterChanger(propertyName="softStartMode")
public void setSoftStartMode(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

setActiveStopMode

@ConfigurationParameterChanger(propertyName="activeStopMode")
public void setActiveStopMode(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

startTurboPump

@Command(type=ACTION,
         name="startTurboPump",
         description="Start turbo pump")
public void startTurboPump()
                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Start pump

Throws:

org.lsst.ccs.drivers.commons.DriverException

stopTurboPump

@Command(type=ACTION,
         name="stopTurboPump",
         description="Stop turbo pump")
public void stopTurboPump()
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Stop pump

Throws:

org.lsst.ccs.drivers.commons.DriverException

checkChannel

protected int[] checkChannel(org.lsst.ccs.monitor.Channel ch)
                      throws Exception

Checks a channel's parameters for validity. The numeric type returned is just an ordinal Channel index; the numeric subtyoe is not used.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

Channel - ch The channel

Returns:

A two-element array containing the encoded type [0] and subtype [1] values.

Throws:

Exception - if any errors found in the parameters.

readChannel

protected double readChannel(org.lsst.ccs.monitor.Channel ch)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

Channel - ch

Returns:

The read value or NaN

readTurboStatus

@Command(type=QUERY,
         level=0,
         name="readTurboStatus",
         description="Get pump status, including operating modes and failure")
public org.lsst.ccs.drivers.twistorr.TwisTorr84.PumpStatus readTurboStatus()
                                                                                                                                                                                                                           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

readTurboFailCode

@Command(type=QUERY,
         name="readTurboFailCode",
         description="Find reason(s) for failure",
         level=0)
public String readTurboFailCode()
                                                                                                                                                      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 it

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTurboLife

@Command(type=QUERY,
         level=1,
         name="readTurboLife",
         description="show TurboPump running-time in hours")
public String readTurboLife()
                                                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Read TurboPump running-time in hours

Returns:

String giving active time

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(type=QUERY,
         level=1,
         name="readAll",
         description="Read all TurboPump 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.

getTurboState

public TurboState getTurboState()

Get the current TurboState

Returns:

TurboState