org.lsst.ccs.drivers.ametek

Class AvcCooler

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ametek.AvcCooler

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

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

Driver for controlling an Ametek AVC cryocooler

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AvcCooler.Mode Public constants

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
AvcCooler() Constructor

Method Summary

Modifier and Type	Method and Description
double[]	getAllPower() Gets all the commanded power values.
double	getDerivative() Gets the derivative control constant.
int	getError() Gets the error word.
String	getFWVersion() Gets the firmware version
double	getIntegral() Gets the integral control constant.
AvcCooler.Mode	getMode() Gets the cooler mode.
double	getPower() Gets the commanded power.
String	getProductType() Gets the product type
double	getProportional() Gets the proportional control constant.
String	getSensor() Gets the sensor type.
double	getTemperature() Gets the target temperature.
boolean	isLocked() Gets the user lock state.
void	lock(String passwd) Sets the user lock state.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int baudRate, int dataChar) Opens a connection.
double	readDouble(String command) Sends a command and reads a double value
String[]	readLines(String command, int nLines) Sends a command and reads the response
double	readPower() Reads the power.
double	readRejectTemp() Reads the reject temperature
String	readString(String command) Sends a command and reads a string
double	readTemperature() Reads the temperature
void	setDerivative(double value) Sets the derivative control constant.
void	setIntegral(double value) Sets the integral control constant.
void	setMode(AvcCooler.Mode mode) Sets the cooler mode.
void	setPassword(String passwd) Sets the user password.
void	setPower(double power) Sets the commanded power.
void	setProportional(double value) Sets the proportional control constant.
void	setTemperature(double temp) Sets the target temperature.
void	unlock(String passwd) Clears the user lock state.

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

close, closeSilent, flush, getTimeout, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, 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

AvcCooler

public AvcCooler()

Constructor

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                 String ident,
                 int baudRate,
                 int dataChar)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Overrides:

open in class org.lsst.ccs.drivers.ascii.Ascii

Parameters:

connType - The enumerated connection type: FTDI or SERIAL

ident - The USB ID (FTDI) or port name (SERIAL)

baudRate - The baud rate

dataChar - The data characteristics

Throws:

org.lsst.ccs.drivers.commons.DriverException

getProductType

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

Gets the product type

Returns:

The product type

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFWVersion

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

Gets the firmware version

Returns:

The firmware version

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSensor

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

Gets the sensor type.

Returns:

The sensor type

Throws:

org.lsst.ccs.drivers.commons.DriverException

lock

public void lock(String passwd)
          throws org.lsst.ccs.drivers.commons.DriverException

Sets the user lock state.

Parameters:

passwd - The password

Throws:

org.lsst.ccs.drivers.commons.DriverException

unlock

public void unlock(String passwd)
            throws org.lsst.ccs.drivers.commons.DriverException

Clears the user lock state.

Parameters:

passwd - The password

Throws:

org.lsst.ccs.drivers.commons.DriverException

isLocked

public boolean isLocked()
                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the user lock state.

Returns:

Whether the user lock is in effect

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPassword

public void setPassword(String passwd)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the user password.

Parameters:

passwd - The new password

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMode

public void setMode(AvcCooler.Mode mode)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the cooler mode.

Parameters:

mode - The mode to set: OFF, ON, POWER

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMode

public AvcCooler.Mode getMode()
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the cooler mode.

Returns:

The mode: OFF, ON, POWER

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperature

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

Sets the target temperature.

Parameters:

temp - The target temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTemperature

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

Gets the target temperature.

Returns:

The target temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPower

public void setPower(double power)
              throws org.lsst.ccs.drivers.commons.DriverException

Sets the commanded power.

Parameters:

power - The power value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPower

public double getPower()
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the commanded power.

Returns:

The power value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAllPower

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

Gets all the commanded power values.

Returns:

The three-element power values array

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTemperature

public double readTemperature()
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads the temperature

Returns:

The temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

readRejectTemp

public double readRejectTemp()
                      throws org.lsst.ccs.drivers.commons.DriverException

Reads the reject temperature

Returns:

The reject temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPower

public double readPower()
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads the power.

Returns:

The power

Throws:

org.lsst.ccs.drivers.commons.DriverException

getError

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

Gets the error word.

Returns:

The error word

Throws:

org.lsst.ccs.drivers.commons.DriverException

setProportional

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

Sets the proportional control constant.

Parameters:

value - The proportional value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getProportional

public double getProportional()
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the proportional control constant.

Returns:

The proportional value

Throws:

org.lsst.ccs.drivers.commons.DriverException

setIntegral

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

Sets the integral control constant.

Parameters:

value - The integral value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getIntegral

public double getIntegral()
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets the integral control constant.

Returns:

The integral value

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDerivative

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

Sets the derivative control constant.

Parameters:

value - The derivative value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getDerivative

public double getDerivative()
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the derivative control constant.

Returns:

The derivative value

Throws:

org.lsst.ccs.drivers.commons.DriverException

readLines

public String[] readLines(String command,
                          int nLines)
                   throws org.lsst.ccs.drivers.commons.DriverException

Sends a command and reads the response

Parameters:

command - The command to send

nLines - The expected number of response lines

Returns:

The array of response lines

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

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

Sends a command and reads a string

Parameters:

command - The command to send

Returns:

The string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDouble

public double readDouble(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sends a command and reads a double value

Parameters:

command - The command to send

Returns:

The double value

Throws:

org.lsst.ccs.drivers.commons.DriverException