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, org.lsst.ccs.services.HasDataProviderInfos

public class InTESTChillerDevice
extends org.lsst.ccs.monitor.Device
implements org.lsst.ccs.services.HasDataProviderInfos

Interfaces with driver for inTEST chiller Version adapted to Chiller driver version (JIRA LSStCCSDRIVERS-432) which sets chiller parameters one at a time, rather than in groups.

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(org.lsst.ccs.monitor.Channel ch) 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.]
ChillerState	getChillerState() Get the current ChillerState
List<org.lsst.ccs.bus.data.DataProviderInfo>	getDataProviderInfos()
double	getDefaultRamp() Gets the default ramp rate.
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
org.lsst.ccs.drivers.chiller.Chiller.ErrorWords	getLastErrorWords() Get last chiller error words
boolean	getTempControlMode() Get temperatire-control mode
protected void	initDevice() Performs basic initialization.
protected void	initialize() Performs full initialization.
String	listError1Bits() Commands to list bit assignments for chiller errors and warnings
String	listError2Bits()
String	listQueries() List queries
String	listSettableParameters() List settable (enumerated) Chiller parameters
String	listStatusBits() List status bits
String	listWarning1Bits()
String	listWarning2Bits()
void	loadChillerParameters() Command to load all Chiller parameters from active non-volatile memory
void	publishParameters() Publish chiller parameter values
String	queryChiller(org.lsst.ccs.drivers.chiller.Chiller.Query quantity) Send query to Chiller and show response
void	quitControllingTemperature() Quit controlling temperature
String	readAnyParameter(int index) Read a specified Chiller setup parameter
protected double	readChannel(org.lsst.ccs.monitor.Channel ch) Reads a channel.
protected void	readChannelGroup(String group) Reads the monitor channel group.
String	readNamedParameter(org.lsst.ccs.drivers.chiller.Chiller.FParam param) Read a Chiller parmeter specified by name
void	saveChillerParameters() Command to save current Chiller parameters to active non-volatile memory
void	selectDUT(boolean dut) Select DUT vs Normal temperature-control mode
void	setFlow(double flow) Set chiller flow rate
void	setParam(org.lsst.ccs.drivers.chiller.Chiller.FParam param, double value) Command to execute a parameter-setting command, enumerared in Chiller.FParam, 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, 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.services.HasDataProviderInfos

finalizeDictionary, publishDataProviderCurrentData

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

build, postBuild, postInit, postShutdown, postStart, shutdown

Field Detail

host

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

Constructor Detail

InTESTChillerDevice

public InTESTChillerDevice()

Method Detail

getDataProviderInfos

public List<org.lsst.ccs.bus.data.DataProviderInfo> getDataProviderInfos()

Specified by:

getDataProviderInfos in interface org.lsst.ccs.services.HasDataProviderInfos

initDevice

protected void initDevice()

Performs basic initialization. Verify that all ConfigurationParameters are set.

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(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, just set to 0.

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.

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(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

getTempControlMode

public boolean getTempControlMode()

Get temperatire-control mode

Returns:

boolean true if DUT mode, false if Normal ode

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

getLastErrorWords

public org.lsst.ccs.drivers.chiller.Chiller.ErrorWords getLastErrorWords()

Get last chiller error words

Returns:

ErrorWords

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

readAnyParameter

@Command(type=QUERY,
         level=0,
         name="readAnyParameter",
         description="Read value of specified parameter")
public String readAnyParameter(@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 (just the parameter value)

Throws:

org.lsst.ccs.drivers.commons.DriverException

listSettableParameters

@Command(type=QUERY,
         level=0,
         name="listSettableParameters",
         description="List parameters available for public setting")
public String listSettableParameters()

List settable (enumerated) Chiller parameters

Returns:

Table listing enumeraed parameter-setting commands

readNamedParameter

@Command(type=QUERY,
         level=0,
         name="readNamedParameter",
         description="Read value of named parameter")
public String readNamedParameter(@Argument(description="enum of parameter")
                                                                                                                                                                  org.lsst.ccs.drivers.chiller.Chiller.FParam param)
                                                                                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Read a Chiller parmeter specified by name

Parameters:

FParam - (parameter name)

Returns:

String

Throws:

Driver - Exception

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

getChillerState

public ChillerState getChillerState()

Get the current ChillerState

Returns:

ChillerState

showChillerState

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

Show current chiller state

Returns:

String

listError1Bits

@Command(type=QUERY,
         level=0,
         name="listError1Bits")
public String listError1Bits()

Commands to list bit assignments for chiller errors and warnings

listError2Bits

@Command(type=QUERY,
         level=0,
         name="listError2Bits")
public String listError2Bits()

listWarning1Bits

@Command(type=QUERY,
         level=0,
         name="listWarning1Bits")
public String listWarning1Bits()

listWarning2Bits

@Command(type=QUERY,
         level=0,
         name="listWarning2Bits")
public String listWarning2Bits()

getDefaultRamp

public double getDefaultRamp()

Gets the default ramp rate. Temporary: block parmeter-read if device not online.

Returns:

The ramp rate (deg/minute)

setParam

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

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

Parameters:

Chiller.FParam - (specifies parameter)

double - (value to set)

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

selectDUT

@Command(type=ACTION,
         level=1,
         name="selectDUT",
         autoAck=false,
         description="Select DUT vs Normal temperature-control mode")
public void selectDUT(@Argument(description="true for DUT")
                                                                                                                                                                                       boolean dut)
                                                                                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Select DUT vs Normal temperature-control mode

Parameters:

boolean - true for DUT, false for Normal

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

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

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="set flow rate (gpm) of chilled fluie")
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

publishParameters

public void publishParameters()

Publish chiller parameter values