org.lsst.ccs.subsystem.refrig

Class InTESTChillerDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.refrig.InTESTChillerDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HasLifecycle

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

Interfaces with driver for inTEST chiller

Author:

Al Eisner

Field Summary

Fields

Modifier and Type	Field and Description
protected String	host

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

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

Constructor Summary

Constructors

Constructor and Description
InTESTChillerDevice()

Method Summary

Modifier and Type	Method and Description
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
void	emergencyClearErrors() Clear chiller errors and warnings (for emergency use only) [Monitoring routinely clears errors, this might interfere.]
protected String	getGroupForChannel(org.lsst.ccs.monitor.Channel ch) Define Channel groups
org.lsst.ccs.bus.states.AlertState	getLastErrorAlert() Get last chiller alert (CHILLER_ERR) state
protected void	initDevice()
protected void	initialize() Performs full initialization.
String	listQueries() List queries
String	listStatusBits() List status bits
void	loadChillerParameters() Command to load all Chiller parameters from active non-volatile memory
String	queryChiller(org.lsst.ccs.drivers.chiller.Chiller.Query quantity) Send query to Chiller and show response
void	quitControllingTemperature() Quit controlling temperature
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup(String group) Reads the monitor channel group.
String	readParameter(int index) Read a specified Chiller setup parameter
void	saveChillerParameters() Command to save current Chiller parameters to active non-volatile memory
void	setFlow(double flow) Set chiller flow rate
void	setParams(org.lsst.ccs.drivers.chiller.Chiller.SetParam setParam, double... values) Command to execute a parameter-setting command, enumerared in Chiller.SetParam, checking that value gets set as requested.
void	setTankPressure(double value) Command to set chiller tank pressure
void	setTemperature(double temperature) Set chiller temperature and go there using default ramp
void	setTemperatureWithRamp(double temperature, double ramp) Set chiller temperature and go there using provided ramp rate
String	showChillerState() Show current chiller state
String	showErrorWords() Show error and warning words in hex Ascii
String	showEvtReg() Show event register bits.
String	showStatusReg() Show status register bits

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

addLine, checkChannel, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initChannel, initSensors, isEnabled, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, 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

host

@ConfigurationParameter(isFinal=true,
                        description="IP host")
protected volatile String host

Constructor Detail

InTESTChillerDevice

public InTESTChillerDevice()

Method Detail

initDevice

protected void initDevice()

Overrides:

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

getGroupForChannel

protected String getGroupForChannel(org.lsst.ccs.monitor.Channel ch)

Define Channel groups

Overrides:

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

Parameters:

ch - The Channel object

Returns:

A String representing the group this channel belongs to. A null is returned if the Channel belongs to no group.

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

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

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

Parameters:

name - The channel name

hwChan - The hardware channel number

type - The channel type string

subtype - The channel subtype string

Returns:

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

Throws:

Exception - if any errors found in the parameters.

readChannelGroup

protected void readChannelGroup(String group)

Reads the monitor channel group. This method is to be overridden for devices that reads some (or all) of its monitor channels at one time. Results should be saved and then returned (one at a time) by readChannel method.

Overrides:

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

Parameters:

group - The group to be read;

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

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

Parameters:

hwChan - The hardware channel number.

type - The encoded channel type returned by checkChannel.

Returns:

The read value

listQueries

@Command(type=QUERY,
         level=0,
         name="listQueries",
         description="List available queries")
public String listQueries()

List queries

Returns:

Table listing enumeraed queries with descroptions

listStatusBits

@Command(type=QUERY,
         level=0,
         name="listStatusBits",
         description="List status register bits")
public String listStatusBits()

List status bits

Returns:

Table listing enumeraed status bits with descroptions

getLastErrorAlert

public org.lsst.ccs.bus.states.AlertState getLastErrorAlert()

Get last chiller alert (CHILLER_ERR) state

Returns:

AlertState

queryChiller

@Command(type=QUERY,
         level=0,
         name="queryChiller",
         description="send specified query to chiller")
public String queryChiller(@Argument(description="Read Enumerated quantity from Chiller")
                                                                                                                                                        org.lsst.ccs.drivers.chiller.Chiller.Query quantity)
                                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Send query to Chiller and show response

Parameters:

quantity - (enumerated Query)

Returns:

String

Throws:

org.lsst.ccs.drivers.commons.DriverException

readParameter

@Command(type=QUERY,
         level=0,
         name="readParameter",
         description="Read value of specified parameter")
public String readParameter(@Argument(description="index of parameter")
                                                                                                                                                            int index)
                                                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Read a specified Chiller setup parameter

Parameters:

index - of setup parameter

Returns:

String

Throws:

org.lsst.ccs.drivers.commons.DriverException

showEvtReg

@Command(type=ACTION,
         level=1,
         name="showEvtReg",
         description="Show decoded Event Register")
public String showEvtReg()
                                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Show event register bits. Warning: this clears that register.

Returns:

String listing any set bits

Throws:

org.lsst.ccs.drivers.commons.DriverException

showStatusReg

@Command(type=QUERY,
         level=0,
         name="showStatusReg",
         description="Show decoded Event Register")
public String showStatusReg()
                                                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Show status register bits

Returns:

String listing any set bits

Throws:

org.lsst.ccs.drivers.commons.DriverException

showErrorWords

@Command(type=QUERY,
         level=0,
         name="showErrorWords",
         description="Show error and warning words in hex")
public String showErrorWords()
                                                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Show error and warning words in hex Ascii

Returns:

String

Throws:

org.lsst.ccs.drivers.commons.DriverException

showChillerState

@Command(type=QUERY,
         level=0,
         name="showChillerState",
         description="Show ChillerState")
public String showChillerState()

Show current chiller state

Returns:

String

setParams

@Command(type=ACTION,
         level=1,
         name="setParams",
         description="Invoke Chiller command tp set parameter(s)")
public void setParams(@Argument(description="enumerated command")
                                                                                                                                                            org.lsst.ccs.drivers.chiller.Chiller.SetParam setParam,
                                                                                                                                                            @Argument(description="parameter value(s)")
                                                                                                                                                            double... values)
                                                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Command to execute a parameter-setting command, enumerared in Chiller.SetParam, checking that value gets set as requested.

Parameters:

Chiller.SetParam - (specifies command to Chiller controller)

Arguments - to send to Chiller

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTankPressure

@Command(type=ACTION,
         level=1,
         name="setTankPressure",
         description="Set tank pressure in psig")
public void setTankPressure(@Argument(description="Tank pressure set value in psig")
                                                                                                                                                       double value)
                                                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Command to set chiller tank pressure

Parameters:

double - Tank pressure setting (psig)

Throws:

org.lsst.ccs.drivers.commons.DriverException

saveChillerParameters

@Command(type=ACTION,
         level=1,
         name="saveChillerParameters",
         description="save all current chiller F# parameters to active NVM")
public void saveChillerParameters()
                                                                                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Command to save current Chiller parameters to active non-volatile memory

Throws:

org.lsst.ccs.drivers.commons.DriverException

loadChillerParameters

@Command(type=ACTION,
         level=1,
         name="loadChillerParameters",
         description="load all chiller F# parameters from active NVM")
public void loadChillerParameters()
                                                                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Command to load all Chiller parameters from active non-volatile memory

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperature

@Command(type=ACTION,
         level=1,
         name="setTemperature",
         description="go to temperature setting using default ramp")
public void setTemperature(@Argument(description="tempeature in degrees")
                                                                                                                                                                        double temperature)
                                                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Set chiller temperature and go there using default ramp

Parameters:

double - temperature in degrees

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperatureWithRamp

@Command(type=ACTION,
         level=1,
         name="setTemperatureWithRamp",
         description="go to temperature setting using provided ramp")
public void setTemperatureWithRamp(@Argument(description="tempeature in degrees")
                                                                                                                                                                                         double temperature,
                                                                                                                                                                                         @Argument(description="ramp in degrees/min")
                                                                                                                                                                                         double ramp)
                                                                                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Set chiller temperature and go there using provided ramp rate

Parameters:

double - temperature in degrees

double - ramp in degrees/minute

Throws:

org.lsst.ccs.drivers.commons.DriverException

quitControllingTemperature

@Command(type=ACTION,
         level=1,
         name="quitControllingTemperature",
         description="stop controlling temperature")
public void quitControllingTemperature()
                                                                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Quit controlling temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFlow

@Command(type=ACTION,
         level=1,
         name="setFlow",
         description="go to temperature setting using default ramp")
public void setFlow(@Argument(description="flow rate in gpm")
                                                                                                                                                          double flow)
                                                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Set chiller flow rate

Parameters:

double - flow (e.g., gallons per monute)

Throws:

org.lsst.ccs.drivers.commons.DriverException

emergencyClearErrors

@Command(type=ACTION,
         level=1,
         name="emergencyCleaErrors",
         description="clear chiller errors and warnings")
public void emergencyClearErrors()
                                                                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Clear chiller errors and warnings (for emergency use only) [Monitoring routinely clears errors, this might interfere.]

Throws:

org.lsst.ccs.drivers.commons.DriverException