org.lsst.ccs.drivers.chiller

Class Chiller

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.chiller.Chiller

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class Chiller
extends org.lsst.ccs.drivers.ascii.Ascii

Driver for inTEST Chiller.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Chiller.ErrorWords Subclass to hold error and warning words from Chiller Controller
static class	Chiller.EventRegister Enumeration of bits in Event Register
static class	Chiller.FParam Enumeration of chiller parameters to be checked after Set commands
static class	Chiller.Life Enumeration of quantities returned by LIFETIME query
static class	Chiller.Query Enumeration of all "Immediate" Query/Read commands to Chiller, ^ except QFA and REA (both handled separately).
static class	Chiller.SetParam Enumeration of Chiller Commans which set parameters Some commands set more than one parameter, The information included can be used to verify settings
static class	Chiller.StatusRegister Enumeration of bits in Status Register

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ascii.Ascii.DataBits, org.lsst.ccs.drivers.ascii.Ascii.FlowCtrl, org.lsst.ccs.drivers.ascii.Ascii.Option, org.lsst.ccs.drivers.ascii.Ascii.Parity, org.lsst.ccs.drivers.ascii.Ascii.StopBits, org.lsst.ccs.drivers.ascii.Ascii.Terminator

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.commons.DriverConstants

org.lsst.ccs.drivers.commons.DriverConstants.ConnType

Constructor Summary

Constructors

Constructor and Description
Chiller() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearErrors() Clear chiller error and warning bits.
void	clearGuiErrorScreen() Clear error screen on chiller-controller gui
String	decodeEvtReg() Decode event register
String	decodeStatusReg() Decode status register
Chiller.ErrorWords	getErrorWords() Extract and return error and warning words
double	getFlow(Chiller.Query query) Return flow rate (reading or setpoint)
double[]	getHeatCool() Return heating and cooling as percentages (of maximum capacity?).
int	getLifetime(Chiller.Life life) Return a Lifetime quantity
double	getPressure(Chiller.Query query) Return a pressure reading
int	getStatusReg() Get status register
double	getTemperature(Chiller.Query query) Return any temperature (reading or set point)n as a double
String	listQueries() List enumerared queries
String	listStatusBits() List Status Register bits
void	loadParams() Restore all chiller F# parameters from active non-volatile memory
void	lockGui(boolean lock) Lock or unlock GUI
protected static String	makeCommandString(String command, String... args) Makes a command string (borrowed from TestAscii)
void	open(String host) Open a connection to the chiller using default port
void	open(String host, int port) Open a connection to the chiller
String	queryChiller(Chiller.Query query) ^ Send an enumerated query to Chiller and receive response
void	quitControl() Stop controlling temperature
String	readParameter(int index) Read a chiller setup parameter
void	saveParams() Save all current chiller F# parameters to active non-volatile memory
void	sendDirectCommand(String command, String... args) Directly send command string to chiller/ For temporary use, to allow using non-implemented commands, allowed only in debug mode.
void	setDebug(boolean on_off) Set debug mode true or false
void	setFlow(double value) Set chilled fluid flow rate.
void	setParamCommand(Chiller.SetParam setParam, double... values) Implement parameter-setting command (enumerated in SetParam).
void	setTemperature(double value) Go to a temperature using default ramp.
void	setTemperatureWithRamp(double value, double ramp) Go to a temperature using specified ramp.

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

close, closeSilent, flush, getConnTimeout, getTimeout, isDropEcho, isOpen, makeDataCharacteristics, open, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setConnTimeout, setConnTimeout, setDefaultParm, setMultidrop, setOptions, setResponseTerm, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

Chiller

public Chiller()

Constructor.

Method Detail

open

public void open(String host,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException

Open a connection to the chiller

Parameters:

host - The host to connect to

port - Telnet port

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(String host)
          throws org.lsst.ccs.drivers.commons.DriverException

Open a connection to the chiller using default port

Parameters:

host - The host to connect to

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

public void setDebug(boolean on_off)

Set debug mode true or false

Parameters:

on_off -

listQueries

public String listQueries()

List enumerared queries

Returns:

Table of queries abd descriptions

listStatusBits

public String listStatusBits()

List Status Register bits

Returns:

Table of status bits and descriptions

queryChiller

public String queryChiller(Chiller.Query query)
                    throws org.lsst.ccs.drivers.commons.DriverException

^ Send an enumerated query to Chiller and receive response

Parameters:

query - enumerated command identifier

Returns:

value value of quantity requested

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTemperature

public double getTemperature(Chiller.Query query)
                      throws org.lsst.ccs.drivers.commons.DriverException

Return any temperature (reading or set point)n as a double

Parameters:

Query - enumeraion of desired temperature reading

Returns:

temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFlow

public double getFlow(Chiller.Query query)
               throws org.lsst.ccs.drivers.commons.DriverException

Return flow rate (reading or setpoint)

Parameters:

Query - enumeraion of desired flow reading

Returns:

flow

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPressure

public double getPressure(Chiller.Query query)
                   throws org.lsst.ccs.drivers.commons.DriverException

Return a pressure reading

Parameters:

Query - enumeraion of desired pressure reading

Returns:

pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeatCool

public double[] getHeatCool()
                     throws org.lsst.ccs.drivers.commons.DriverException

Return heating and cooling as percentages (of maximum capacity?). (Heat is duty cycle of heater; Cool is duty cycle of cold valve.) No more than one of these should be non-zero at any one time.

Returns:

percentages[heat,cool]

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLifetime

public int getLifetime(Chiller.Life life)
                throws org.lsst.ccs.drivers.commons.DriverException

Return a Lifetime quantity

Parameters:

Enumerated - Life

Returns:

value (int)

Throws:

org.lsst.ccs.drivers.commons.DriverException

decodeEvtReg

public String decodeEvtReg()
                    throws org.lsst.ccs.drivers.commons.DriverException

Decode event register

Returns:

String showing which bits are set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getStatusReg

public int getStatusReg()
                 throws org.lsst.ccs.drivers.commons.DriverException

Get status register

Returns:

Status register as int value

Throws:

org.lsst.ccs.drivers.commons.DriverException

decodeStatusReg

public String decodeStatusReg()
                       throws org.lsst.ccs.drivers.commons.DriverException

Decode status register

Returns:

String showing which bits are set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getErrorWords

public Chiller.ErrorWords getErrorWords()
                                 throws org.lsst.ccs.drivers.commons.DriverException

Extract and return error and warning words

Throws:

org.lsst.ccs.drivers.commons.DriverException

readParameter

public String readParameter(int index)
                     throws org.lsst.ccs.drivers.commons.DriverException

Read a chiller setup parameter

Parameters:

index -

Returns:

value (as a String)

Throws:

DriverExceptiom

org.lsst.ccs.drivers.commons.DriverException

setParamCommand

public void setParamCommand(Chiller.SetParam setParam,
                            double... values)
                     throws org.lsst.ccs.drivers.commons.DriverException

Implement parameter-setting command (enumerated in SetParam). Checks arguments and waits for set values (or times out);

Parameters:

SetParam - (specifies command to Chiller controller)

Arguments - to send to Chiller

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperature

public void setTemperature(double value)
                    throws org.lsst.ccs.drivers.commons.DriverException

Go to a temperature using default ramp. Waits for setpoint value to match request and then returns.

Parameters:

double - temperature value (degrees C)

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

setTemperatureWithRamp

public void setTemperatureWithRamp(double value,
                                   double ramp)
                            throws org.lsst.ccs.drivers.commons.DriverException

Go to a temperature using specified ramp. Waits for setpoint value to match request and then returns.

Parameters:

double - temperature value (degrees C)

double - ramp (degrees C per minute)

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

quitControl

public void quitControl()
                 throws org.lsst.ccs.drivers.commons.DriverException

Stop controlling temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFlow

public void setFlow(double value)
             throws org.lsst.ccs.drivers.commons.DriverException

Set chilled fluid flow rate. Waits for setpoint value to match request and then returns.

Parameters:

double - flow-rate value (gallons per minute)

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

clearErrors

public void clearErrors()
                 throws org.lsst.ccs.drivers.commons.DriverException

Clear chiller error and warning bits. These bits are latched; if the causing condition for a bit persists, the bit will get reasserted after clearing.

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearGuiErrorScreen

public void clearGuiErrorScreen()
                         throws org.lsst.ccs.drivers.commons.DriverException

Clear error screen on chiller-controller gui

Throws:

org.lsst.ccs.drivers.commons.DriverException

lockGui

public void lockGui(boolean lock)
             throws org.lsst.ccs.drivers.commons.DriverException

Lock or unlock GUI

Parameters:

boolean - lock/unlock if true/false

Throws:

org.lsst.ccs.drivers.commons.DriverException

saveParams

public void saveParams()
                throws org.lsst.ccs.drivers.commons.DriverException

Save all current chiller F# parameters to active non-volatile memory

Throws:

org.lsst.ccs.drivers.commons.DriverException

loadParams

public void loadParams()
                throws org.lsst.ccs.drivers.commons.DriverException

Restore all chiller F# parameters from active non-volatile memory

Throws:

org.lsst.ccs.drivers.commons.DriverException

sendDirectCommand

public void sendDirectCommand(String command,
                              String... args)
                       throws org.lsst.ccs.drivers.commons.DriverException

Directly send command string to chiller/ For temporary use, to allow using non-implemented commands, allowed only in debug mode. Do not use for commands expecting a response.

Parameters:

chiller - command String

args - (if any)

Throws:

DeiverExceptiom

org.lsst.ccs.drivers.commons.DriverException

makeCommandString

protected static String makeCommandString(String command,
                                          String... args)

Makes a command string (borrowed from TestAscii)

Parameters:

command - The command word

args - The command arguments

Returns:

The generated command string