org.lsst.ccs.drivers.chiller

Class TestChiller

java.lang.Object

org.lsst.ccs.drivers.chiller.TestChiller

public class TestChiller
extends Object

Chiller test program driver

Constructor Summary

Constructors

Constructor and Description
TestChiller()

Method Summary

Modifier and Type	Method and Description
void	close() Closes connection to a device.
String	listQueries() List queries
String	listSetParams() List parameter-setting commands
String	listStatusBits() List status bits
void	open(String host, int port) Opens connection to chiller
String	queryChiller(Chiller.Query quantity) Send query to Chiller and show response
String	readParameter(int index) Read a specified Chiller setup parameter
void	sendDebugCommand(String command, String... args) Send non-Query command string to chiller.
String	setAndReadAnyParameter(int index, String value) Set and read back a specified Chiller setup parameter
void	setAnyParameter(int index, String value) Set a specified Chiller setup parameter
void	setDebug(boolean debug) Set debug mode
void	setParams(Chiller.SetParam setParam, double... values) Command to execute a parameter-setting command, enumerared in Chiller.SetParam, checking that value gets set as requested.
String	showErrorWords() Show error and warning words in hex Ascii
String	showEvtReg() Show event register bits
String	showFlow(Chiller.Query quantity) Show a flow-rate value (extracted from query response)
String	showHeatCool() Show heating and cooling percentages (extracted from query)
String	showLifetime(Chiller.Life quantity) Show a lifetime value (extracted from query response)
String	showPressure(Chiller.Query quantity) Show a pressure value (extracted from query response)
String	showStatusReg() Show status register bits
String	showTemperature(Chiller.Query quantity) Show a temperature value (extracted from query response)

Methods inherited from class java.lang.Object

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

Constructor Detail

TestChiller

public TestChiller()

Method Detail

open

@Command(name="open",
         description="Open connection to chiller")
public void open(@Argument(description="Host name")
                                                                                          String host,
                                                                                          @Argument(description="Port number",defaultValue="9760")
                                                                                          int port)
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to chiller

Parameters:

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

@Command(name="close",
         description="Close connection to chiller")
public void close()
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Closes connection to a device.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

@Command(name="setDebug",
         description="set debug mode true/false")
public void setDebug(@Argument(description="true/false")
                                                                                                 boolean debug)

Set debug mode

Parameters:

debug -

listQueries

@Command(name="listQueries",
         description="List available queries")
public String listQueries()

List queries

Returns:

Table listing enumeraed queries with descroptions

listSetParams

@Command(name="listSetParams",
         description="List implemented parameter-setting commands")
public String listSetParams()

List parameter-setting commands

Returns:

Table listing enumeraed parameter-setting commands

listStatusBits

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

List status bits

Returns:

Table listing enumeraed status bits with descroptions

queryChiller

@Command(name="queryChiller",
         description="send specified query to chiller")
public String queryChiller(@Argument(description="Read Enumerated quantity from 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(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

setAnyParameter

@Command(name="setAnyParameter",
         description="Set value of specified parameter")
public void setAnyParameter(@Argument(description="index of parameter")
                                                                                                                      int index,
                                                                                                                      @Argument(description="value to be set")
                                                                                                                      String value)
                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Set a specified Chiller setup parameter

Parameters:

index - of setup parameter

value - to be set (as a String)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAndReadAnyParameter

@Command(name="setAndReadAnyParameter",
         description="Set value of specified paramete and read it backr")
public String setAndReadAnyParameter(@Argument(description="index of parameter")
                                                                                                                                                       int index,
                                                                                                                                                       @Argument(description="value to set")
                                                                                                                                                       String value)
                                                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Set and read back a specified Chiller setup parameter

Parameters:

index - of setup parameter

value - to be set (as a String)

Returns:

read-back value

Throws:

org.lsst.ccs.drivers.commons.DriverException

setParams

@Command(name="setParams",
         description="Invoke Chiller command tp set parameter(s)")
public void setParams(@Argument(description="enumerated command")
                                                                                                                    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:

SetParam - (specifies command to Chiller controller)

Arguments - to send to Chiller

Throws:

org.lsst.ccs.drivers.commons.DriverException

showTemperature

@Command(name="showTemperature",
         description="numerical value of a temperature reading or set-point")
public String showTemperature(@Argument(description="which quantity")
                                                                                                                                             Chiller.Query quantity)
                                                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Show a temperature value (extracted from query response)

Parameters:

Chiller.Query - (wprks for temperature readings and set-points)

Returns:

String representation of extracted value

Throws:

org.lsst.ccs.drivers.commons.DriverException

showFlow

@Command(name="showFlow",
         description="numerical value of a flow reading or set-point")
public String showFlow(@Argument(description="which quantity")
                                                                                                                        Chiller.Query quantity)
                                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Show a flow-rate value (extracted from query response)

Parameters:

Chiller.Query -

Returns:

String representation of extracted value

Throws:

org.lsst.ccs.drivers.commons.DriverException

showPressure

@Command(name="showPressure",
         description="numerical value of a pressure reading")
public String showPressure(@Argument(description="which quantity")
                                                                                                                       Chiller.Query quantity)
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Show a pressure value (extracted from query response)

Parameters:

Chiller.Query -

Returns:

String representation of extracted value

Throws:

org.lsst.ccs.drivers.commons.DriverException

showLifetime

@Command(name="showLifetime",
         description="numerical value of lifetime")
public String showLifetime(@Argument(description="which quantity")
                                                                                                             Chiller.Life quantity)
                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Show a lifetime value (extracted from query response)

Parameters:

Chiller.Life -

Returns:

String representation of extracted value

Throws:

org.lsst.ccs.drivers.commons.DriverException

showHeatCool

@Command(name="showHeatCool",
         description="numerical values of heat/cool percentages")
public String showHeatCool()
                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Show heating and cooling percentages (extracted from query)

Returns:

String representation of extracted values

Throws:

org.lsst.ccs.drivers.commons.DriverException

showEvtReg

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

Show event register bits

Returns:

String listing any set bits

Throws:

org.lsst.ccs.drivers.commons.DriverException

showStatusReg

@Command(name="showStatusReg",
         description="Show decoded Status 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(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

sendDebugCommand

@Command(name="sendDebugCommand",
         description="Send non-query command to chiller, debug-mode")
public void sendDebugCommand(@Argument(description="command String")
                                                                                                                                     String command,
                                                                                                                                     @Argument(description="arguments to command")
                                                                                                                                     String... args)
                                                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Send non-Query command string to chiller. Debug-mode only.

Parameters:

command - (String)

args - (arguments, if any)

Throws:

org.lsst.ccs.drivers.commons.DriverException