org.lsst.ccs.subsystem.pathfinder

Class Mks9xxDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.pathfinder.Mks9xxDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

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

Interface to an MKS 972/974/925 vacuum gauge.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Mks9xxDevice.OnOff Constants.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
Mks9xxDevice()

Method Summary

Modifier and Type	Method and Description
void	clearRetryCount() Clears command retry count.
void	close() Closes the connection.
String	formatReadBuffer() Formats read buffer contents.
String	getAnalogOut(int chan) Gets an analog output setting.
double	getAtmospheric() Gets the atmospheric pressure calibration factor.
double	getAutoZeroLimit() Gets the MicroPirani auto zero limit.
int	getBaudRate() Gets the baud rate.
org.lsst.ccs.drivers.mks.Model9XX.Gas	getCalibrationGas() Gets the calibration gas.
int	getCCProtDelay() Gets cold cathode protection delay.
String	getDeviceType() Gets the transducer device type.
String	getFirmwareVersion() Gets the firmware version.
double	getFullScale() Gets the cold cathode full-scale pressure calibration factor.
String	getHardwareVersion() Gets the hardware version.
double	getHighIntPressure() Gets high integration pressure.
double	getLowIntPressure() Gets low integration pressure.
String	getManufacturer() Gets the manufacturer.
String	getModel() Gets the model.
double	getOffPressureCC() Gets cold cathode turn-off pressure.
double	getOnPressureCC() Gets cold cathode turn-on pressure.
String	getPartNumber() Gets the part number.
org.lsst.ccs.drivers.mks.Model9XX.Unit	getPressureUnit() Gets the pressure unit.
String	getReadBuffer() Gets read buffer contents.
org.lsst.ccs.drivers.mks.Model9XX.Direction	getRelayDirection(int relay) Gets a relay trip direction.
org.lsst.ccs.drivers.mks.Model9XX.Enable	getRelayEnable(int relay) Gets a relay enabled state.
double	getRelayHyst(int relay) Gets a relay hysteresis value.
double	getRelayTrip(int relay) Gets a relay trip point.
int	getRetryCount() Gets command retry count.
int	getRetryLimit() Gets command retry limit.
double	getSensorDose() Gets the sensor pressure dose.
double	getSensorDoseLimit() Gets cold cathode pressure dose limit.
int	getSensorTimeOn() Gets the sensor time on.
String	getSerialNumber() Gets the serial number.
int	getTimeOn() Gets the transducer time on.
String	getTransStatus() Gets the transducer status.
String	getUserTag() Gets the user tag.
void	initDevice() Performs configuration.
void	initialize() Performs full initialization.
boolean	isCCAutoPowerOn() Gets cold cathode auto power state.
boolean	isCCPowerOn() Gets cold cathode power state.
boolean	isIdentifying() Gets the identify state.
boolean	isRelayActive(int relay) Gets whether a relay is active.
boolean	isRelayDelayed() Gets the relay trip delayed state.
boolean	isResponseDelayed() Gets the RS-485 delayed response state.
boolean	isSwitchEnabled() Gets the switch enabled state.
double	readChannel(org.lsst.ccs.monitor.Channel ch)
double	readPressure(org.lsst.ccs.drivers.mks.Model9XX.Sensor sensor) Reads the pressure.
double	readTemperature() Reads the MicroPirani temperature.
void	setCCAutoPower(Mks9xxDevice.OnOff onOff) Set cold cathode auto power on state
void	setCCPower(Mks9xxDevice.OnOff onOff) Set cold cathode power state
void	setRetryLimit(int limit) Sets command retry limit.
void	setTimeout(double timeout) Sets read timeout.

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

addLine, checkChannel, checkChannel, checkHwLine, checkLine, checkOnline, 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

Constructor Detail

Mks9xxDevice

public Mks9xxDevice()

Method Detail

initDevice

public void initDevice()

Performs configuration.

Overrides:

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

initialize

public void initialize()

Performs full initialization.

Specified by:

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

close

public void close()

Closes the connection.

Specified by:

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

readChannel

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

Overrides:

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

readPressure

@Command(type=QUERY,
         level=0,
         description="Read the pressure")
public double readPressure(@Argument(description="Sensor name")
                                                                                                            org.lsst.ccs.drivers.mks.Model9XX.Sensor sensor)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Reads the pressure.

Parameters:

sensor - Which pressure sensor to read

Returns:

The pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTemperature

@Command(type=QUERY,
         level=0,
         description="Read the Micropirani temperature")
public double readTemperature()
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Reads the MicroPirani temperature.

Returns:

The temperature (C)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayTrip

@Command(type=QUERY,
         level=0,
         description="Get a relay trip point")
public double getRelayTrip(@Argument(description="Relay number")
                                                                                                                 int relay)
                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Gets a relay trip point.

Parameters:

relay - The relay number

Returns:

The trip point

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayHyst

@Command(type=QUERY,
         level=0,
         description="Get a relay hysteresis value")
public double getRelayHyst(int relay)
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Gets a relay hysteresis value.

Parameters:

relay - The relay number (1 - 3)

Returns:

The hysteresis value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayDirection

@Command(type=QUERY,
         level=0,
         description="Get a relay trip direction")
public org.lsst.ccs.drivers.mks.Model9XX.Direction getRelayDirection(@Argument(description="Relay number")
                                                                                                                                                               int relay)
                                                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets a relay trip direction.

Parameters:

relay - The relay number

Returns:

The trip direction enum

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayEnable

@Command(type=QUERY,
         level=0,
         description="Get a relay enabled state")
public org.lsst.ccs.drivers.mks.Model9XX.Enable getRelayEnable(@Argument(description="Relay number")
                                                                                                                                                        int relay)
                                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Gets a relay enabled state.

Parameters:

relay - The relay number

Returns:

The enabled state enum

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayActive

@Command(type=QUERY,
         level=0,
         description="Get whether a relay is active")
public boolean isRelayActive(@Argument(description="Relay number")
                                                                                                                          int relay)
                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Gets whether a relay is active.

Parameters:

relay - The relay number (1 - 3)

Returns:

Whether active

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAnalogOut

@Command(type=QUERY,
         level=0,
         description="Get an analog output setting")
public String getAnalogOut(@Argument(description="Channel number")
                                                                                                                       int chan)
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Gets an analog output setting.

Parameters:

chan - The analog channel number

Returns:

The setting string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCalibrationGas

@Command(type=QUERY,
         level=0,
         description="Get the calibration gas")
public org.lsst.ccs.drivers.mks.Model9XX.Gas getCalibrationGas()
                                                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Gets the calibration gas.

Returns:

The calibration gas enum

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDeviceType

@Command(type=QUERY,
         level=0,
         description="Get the device type")
public String getDeviceType()
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the transducer device type.

Returns:

The device type name

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFirmwareVersion

@Command(type=QUERY,
         level=0,
         description="Get the firmware version")
public String getFirmwareVersion()
                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the firmware version.

Returns:

The firmware version

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHardwareVersion

@Command(type=QUERY,
         level=0,
         description="Get the hardware version")
public String getHardwareVersion()
                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the hardware version.

Returns:

The hardware version

Throws:

org.lsst.ccs.drivers.commons.DriverException

getManufacturer

@Command(type=QUERY,
         level=0,
         description="Get the manufacturer")
public String getManufacturer()
                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Gets the manufacturer.

Returns:

The manufacturer

Throws:

org.lsst.ccs.drivers.commons.DriverException

getModel

@Command(type=QUERY,
         level=0,
         description="Get the model")
public String getModel()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Gets the model.

Returns:

The model

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPartNumber

@Command(type=QUERY,
         level=0,
         description="Get the part number")
public String getPartNumber()
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the part number.

Returns:

The part number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSerialNumber

@Command(type=QUERY,
         level=0,
         description="Get the serial number")
public String getSerialNumber()
                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the serial number.

Returns:

The serial number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTimeOn

@Command(type=QUERY,
         level=0,
         description="Get the transducer time on (hours)")
public int getTimeOn()
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Gets the transducer time on.

Returns:

The transducer time on (hours)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSensorTimeOn

@Command(type=QUERY,
         level=0,
         description="Get the sensor time on (hours)")
public int getSensorTimeOn()
                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the sensor time on.

Returns:

The sensor time on (hours)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSensorDose

@Command(type=QUERY,
         level=0,
         description="Get the sensor pressure dose")
public double getSensorDose()
                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the sensor pressure dose.

Returns:

The sensor pressure dose

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTransStatus

@Command(type=QUERY,
         level=0,
         description="Get the transducer status")
public String getTransStatus()
                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Gets the transducer status.

Returns:

The status string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPressureUnit

@Command(type=QUERY,
         level=0,
         description="Get the pressure unit")
public org.lsst.ccs.drivers.mks.Model9XX.Unit getPressureUnit()
                                                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the pressure unit.

Returns:

The pressure unit

Throws:

org.lsst.ccs.drivers.commons.DriverException

getBaudRate

@Command(type=QUERY,
         level=0,
         description="Get the baud rate")
public int getBaudRate()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the baud rate.

Returns:

The baud rate: 4800, 9600, 19200, 38400, 57600, 115200 or 230400

Throws:

org.lsst.ccs.drivers.commons.DriverException

getUserTag

@Command(type=QUERY,
         level=0,
         description="Get the user tag")
public String getUserTag()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the user tag.

Returns:

The user tag string

Throws:

org.lsst.ccs.drivers.commons.DriverException

isSwitchEnabled

@Command(type=QUERY,
         level=0,
         description="Get the switch enabled state")
public boolean isSwitchEnabled()
                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the switch enabled state.

Returns:

Whether the switch is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

isResponseDelayed

@Command(type=QUERY,
         level=0,
         description="Get the RS-485 delayed response state")
public boolean isResponseDelayed()
                                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Gets the RS-485 delayed response state.

Returns:

Whether delayed response enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayDelayed

@Command(type=QUERY,
         level=0,
         description="Get the relay trip delayed state")
public boolean isRelayDelayed()
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the relay trip delayed state.

Returns:

Whether relay trip delay is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

isIdentifying

@Command(type=QUERY,
         level=0,
         description="Get the identify state")
public boolean isIdentifying()
                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the identify state.

Returns:

Whether the identify light is flashing

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAtmospheric

@Command(type=QUERY,
         level=0,
         description="Get the atmospheric pressure calibration factor")
public double getAtmospheric()
                                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the atmospheric pressure calibration factor.

Returns:

The atmospheric pressure factor

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAutoZeroLimit

@Command(type=QUERY,
         level=0,
         description="Get the MicroPirani auto zero limit")
public double getAutoZeroLimit()
                                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Gets the MicroPirani auto zero limit.

Returns:

The auto zero limit pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFullScale

@Command(type=QUERY,
         level=0,
         description="Get the cold cathode full-scale pressure calibration factor")
public double getFullScale()
                                                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Gets the cold cathode full-scale pressure calibration factor.

Returns:

The full-scale pressure factor

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOnPressureCC

@Command(type=QUERY,
         level=0,
         description="Get cold cathode turn-on pressure")
public double getOnPressureCC()
                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode turn-on pressure.

Returns:

The turn-on pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOffPressureCC

@Command(type=QUERY,
         level=0,
         description="Get cold cathode turn-off pressure")
public double getOffPressureCC()
                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode turn-off pressure.

Returns:

The turn-off pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLowIntPressure

@Command(type=QUERY,
         level=0,
         description="Get the low integration pressure")
public double getLowIntPressure()
                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Gets low integration pressure.

Returns:

The pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHighIntPressure

@Command(type=QUERY,
         level=0,
         description="Get the high integration pressure")
public double getHighIntPressure()
                                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Gets high integration pressure.

Returns:

The pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

isCCAutoPowerOn

@Command(type=QUERY,
         level=0,
         description="Get cold cathode auto power state")
public boolean isCCAutoPowerOn()
                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode auto power state.

Returns:

Whether auto power state is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

isCCPowerOn

@Command(type=QUERY,
         level=0,
         description="Get cold cathode power state")
public boolean isCCPowerOn()
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode power state.

Returns:

Whether power state is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCCPower

@Command(type=ACTION,
         level=10,
         description="Set cold cathode power state")
public void setCCPower(@Argument(description="ON or OFF")
                                                                                                                     Mks9xxDevice.OnOff onOff)
                                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Set cold cathode power state

Parameters:

ON - or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCCAutoPower

@Command(type=ACTION,
         level=10,
         description="Set cold cathode auto power on state")
public void setCCAutoPower(@Argument(description="ON or OFF")
                                                                                                                                 Mks9xxDevice.OnOff onOff)
                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Set cold cathode auto power on state

Parameters:

ON - or OFF

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCCProtDelay

@Command(type=QUERY,
         level=0,
         description="Get cold cathode protection delay")
public int getCCProtDelay()
                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode protection delay.

Returns:

Protection delay time (-1 = OFF)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSensorDoseLimit

@Command(type=QUERY,
         level=0,
         description="Get cold cathode pressure dose limit")
public double getSensorDoseLimit()
                                                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Gets cold cathode pressure dose limit.

Returns:

The pressure dose

Throws:

org.lsst.ccs.drivers.commons.DriverException

getReadBuffer

@Command(type=QUERY,
         level=0,
         description="Get read buffer contents")
public String getReadBuffer()
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Gets read buffer contents.

Returns:

The buffer contents

Throws:

org.lsst.ccs.drivers.commons.DriverException

formatReadBuffer

@Command(type=QUERY,
         level=0,
         description="Format read buffer contents")
public String formatReadBuffer()
                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Formats read buffer contents.

Returns:

The formatted buffer contents

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

@Command(type=ACTION,
         level=50,
         description="Set read timeout")
public void setTimeout(@Argument(description="The timeout (secs)")
                                                                                                         double timeout)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Sets read timeout.

Parameters:

timeout - The timeout (secs)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRetryLimit

@Command(type=QUERY,
         level=0,
         description="Get command retry limit")
public int getRetryLimit()

Gets command retry limit.

Returns:

The retry limit

setRetryLimit

@Command(type=ACTION,
         level=50,
         description="Set command retry limit")
public void setRetryLimit(@Argument(description="The retry limit")
                                                                                                                   int limit)

Sets command retry limit.

Parameters:

limit - The limit

getRetryCount

@Command(type=QUERY,
         level=0,
         description="Get command retry count")
public int getRetryCount()

Gets command retry count.

Returns:

The retry count

clearRetryCount

@Command(type=ACTION,
         level=50,
         description="Clear command retry count")
public void clearRetryCount()

Clears command retry count.