org.lsst.ccs.drivers.cryocon

Class M24C

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.cryocon.M24C

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class M24C
extends org.lsst.ccs.drivers.scpi.Scpi

Enables access to a Cryogenic Temperature controller Model 24C

Author:

Heather Kelly

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	NUM_LOOPS Public constants

Fields inherited from class org.lsst.ccs.drivers.scpi.Scpi

CHECK_CONTAINS, CHECK_ENDS_WITH, CHECK_EQUALS, CHECK_MATCHES, CHECK_STARTS_WITH, ESR_ANY_ERROR, ESR_COMMAND_ERROR, ESR_DEVICE_ERROR, ESR_EXECUTION_ERROR, ESR_QUERY_ERROR, IDENT_FW_VERSION, IDENT_MANUFACTURER, IDENT_MODEL_NAME, IDENT_SERIAL_NUMBER, SB_ERROR_QUEUE, SB_EVENT_STATUS, SB_MASTER_STATUS, SB_MESSAGE_AVAILABLE, SB_OPERATION_STATUS, SB_QUESTIONABLE_STATUS

Constructor Summary

Constructors

Constructor and Description
M24C()

Method Summary

Modifier and Type	Method and Description
void	enableOtd(boolean enab) Sets whether Over Temperature Disconnect (OTD) is enabled
String	getControl() Gets the temperature control state
String	getControlType(int loop) Gets the control type for a loop
double	getHeaterMax(int loop) Gets the maximum heater power for a loop
double	getHeaterPower(int loop) Gets the heater power for a manually-controlled loop
String	getHeaterRange(int loop) Gets the heater range for a loop
double	getHtrRead(int loop) Gets the heater power level for a loop
double	getMaxSetPoint(int loop) Gets the maximum set point for a loop
char	getOtdSource() Gets the OTD source channel
double	getOtdTemp() Gets the OTD temperature limit
double	getPID_D(int loop) Deprecated.
double	getPID_I(int loop) Deprecated.
double	getPID_P(int loop) Deprecated.
double	getPidD(int loop) Gets the PID D parameter for a loop
double	getPidI(int loop) Gets the PID I parameter for a loop
double	getPidP(int loop) Gets the PID P parameter for a loop
double	getSetPoint(int loop) Gets the current set point for a loop
char	getSource(int loop) Gets the channel source for a loop
double	getTemp(char channel) Reads the temperature of a channel
String	getType(char channel) Gets the sensor type for a channel
char	getUnit(char channel) Gets the temperature units for a channel
boolean	isInControl() Gets whether the device is controlling the temperature
boolean	isOtdEnabled() Gets whether Over Temperature Disconnect (OTD) is enabled
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int parm1, int parm2) Opens a connection to the device.
String	readString(String cmnd) Reads a string response after sending a command.
void	setControlType(int loop, String type) Sets the control type for a loop
void	setHeaterMax(int loop, double power) Sets the maximum heater power for a loop
void	setHeaterPower(int loop, double power) Sets the heater power for a manually-controlled loop
void	setHeaterRange(int loop, String range) Sets the heater range for a loop
void	setMaxSetPoint(int loop, double temp) Sets the maximum set point for a loop
void	setOtdSource(char channel) Sets the OTD source channel
void	setOtdTemp(double temp) Sets the OTD temperature limit
void	setPidD(int loop, double dValue) Sets the PID D parameter for a loop.
void	setPidI(int loop, double iValue) Sets the PID I parameter for a loop.
void	setPidP(int loop, double pValue) Sets the PID P parameter for a loop.
void	setSetPoint(int loop, double temp) Sets the set point for a loop
void	setSource(int loop, char channel) Sets the channel source for a loop
void	setToControl() Sets the device to control the temperature
void	setType(char channel, String typ) Sets the sensor type for a channel
void	setUnit(char channel, char unit) Sets the temperature units for a channel
void	stopControl() Sets the device to stop temperature control
void	writeCommand(String cmnd) Sends a command.

Methods inherited from class org.lsst.ccs.drivers.scpi.Scpi

checkError, checkIdentification, clearStatus, enableOperationComplete, getError, getEventStatus, getEventStatusEnable, getIdentification, getOperationComplete, getServiceRequestEnable, getStatusByte, makeChannelList, makeChannelList, readDouble, readDoubleArray, readFloat, readFloatArray, readInteger, readIntegerArray, readStringArray, reset, runSelfTest, setEventStatusEnable, setServiceRequestEnable, testIdentification, waitCompletion

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

close, closeSilent, flush, getConnTimeout, getTimeout, isDropEcho, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setConnTimeout, setConnTimeout, setDefaultBaud, setDefaultParm, setDefaultPort, 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

Field Detail

NUM_LOOPS

public static final int NUM_LOOPS

Public constants

See Also:

Constant Field Values

Constructor Detail

M24C

public M24C()

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device. This is the open method that overrides the superclass open when extra functionality is needed.

Overrides:

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

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: host name or IP address for network; device name for serial

parm1 - The first device parameter: port number for network; baud rate for serial

parm2 - The second device parameter: unused for network; encoded data characteristics for serial: 0 sets 8-bit, no parity, 1 stop bit, no flow ctrl

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMaxSetPoint

public double getMaxSetPoint(int loop)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the maximum set point for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The maximum set point

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxSetPoint

public void setMaxSetPoint(int loop,
                           double temp)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the maximum set point for a loop

Parameters:

loop - The loop number (1-4)

temp - The temperature to set in the units specified via setUnit

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSetPoint

public double getSetPoint(int loop)
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets the current set point for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The current set point

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSetPoint

public void setSetPoint(int loop,
                        double temp)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the set point for a loop

Parameters:

loop - The loop number (1-4)

temp - The temperature to set in the units specified via setUnit

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHtrRead

public double getHtrRead(int loop)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the heater power level for a loop

Parameters:

loop - The loop number (1-4)

Returns:

% of full power

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPidP

public void setPidP(int loop,
                    double pValue)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the PID P parameter for a loop.

Parameters:

loop - The loop number (1-4)

pValue - The P value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPidP

public double getPidP(int loop)
               throws org.lsst.ccs.drivers.commons.DriverException

Gets the PID P parameter for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The P parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPID_P

@Deprecated
public double getPID_P(int loop)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPidI

public void setPidI(int loop,
                    double iValue)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the PID I parameter for a loop.

Parameters:

loop - The loop number (1-4)

iValue - The I value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPidI

public double getPidI(int loop)
               throws org.lsst.ccs.drivers.commons.DriverException

Gets the PID I parameter for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The I parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPID_I

@Deprecated
public double getPID_I(int loop)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPidD

public void setPidD(int loop,
                    double dValue)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the PID D parameter for a loop.

Parameters:

loop - The loop number (1-4)

dValue - The D value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPidD

public double getPidD(int loop)
               throws org.lsst.ccs.drivers.commons.DriverException

Gets the PID D parameter for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The D parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPID_D

@Deprecated
public double getPID_D(int loop)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSource

public char getSource(int loop)
               throws org.lsst.ccs.drivers.commons.DriverException

Gets the channel source for a loop

Parameters:

loop - The loop number (1-4)

Returns:

channel [A,D]

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSource

public void setSource(int loop,
                      char channel)
               throws org.lsst.ccs.drivers.commons.DriverException

Sets the channel source for a loop

Parameters:

loop - The loop number (1-4)

channel - The channel ID (A-D)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getControlType

public String getControlType(int loop)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the control type for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The type string: OFF, PID, MAN, TABLE. RAMPP or RAMPT

Throws:

org.lsst.ccs.drivers.commons.DriverException

setControlType

public void setControlType(int loop,
                           String type)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the control type for a loop

Parameters:

loop - The loop number (1-4)

type - The type string: OFF, PID, MAN, TABLE. RAMPP or RAMPT

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeaterRange

public String getHeaterRange(int loop)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the heater range for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The range string: HI, MID, LOW, 10V or 5V

Throws:

org.lsst.ccs.drivers.commons.DriverException

setHeaterRange

public void setHeaterRange(int loop,
                           String range)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the heater range for a loop

Parameters:

loop - The loop number (1-4)

range - The range string: HI, MID, LOW, 10V or 5V

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeaterMax

public double getHeaterMax(int loop)
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets the maximum heater power for a loop

Parameters:

loop - The loop number (1-4)

Returns:

The heater power as a percentage of the maximum

Throws:

org.lsst.ccs.drivers.commons.DriverException

setHeaterMax

public void setHeaterMax(int loop,
                         double power)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the maximum heater power for a loop

Parameters:

loop - The loop number (1-4)

power - The heater power as a percentage of the maximum

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeaterPower

public double getHeaterPower(int loop)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the heater power for a manually-controlled loop

Parameters:

loop - The loop number (1-4)

Returns:

The heater power as a percentage of the maximum

Throws:

org.lsst.ccs.drivers.commons.DriverException

setHeaterPower

public void setHeaterPower(int loop,
                           double power)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the heater power for a manually-controlled loop

Parameters:

loop - The loop number (1-4)

power - The heater power as a percentage of the maximum

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTemp

public double getTemp(char channel)
               throws org.lsst.ccs.drivers.commons.DriverException

Reads the temperature of a channel

Parameters:

channel - The channel ID (A-D)

Returns:

The temperature in the units specified vis setUnit

Throws:

org.lsst.ccs.drivers.commons.DriverException

getUnit

public char getUnit(char channel)
             throws org.lsst.ccs.drivers.commons.DriverException

Gets the temperature units for a channel

Parameters:

channel - The channel ID (A-D)

Returns:

Temperature unit: K, F, C, S (sensor units) or blank (not used)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setUnit

public void setUnit(char channel,
                    char unit)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the temperature units for a channel

Parameters:

channel - The channel ID (A-D)

unit - Temperature unit: K, F, C or S (sensor units)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getType

public String getType(char channel)
               throws org.lsst.ccs.drivers.commons.DriverException

Gets the sensor type for a channel

Parameters:

channel - The channel ID (A-D)

Returns:

The sensor type string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setType

public void setType(char channel,
                    String typ)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the sensor type for a channel

Parameters:

channel - The channel ID (A-D)

typ - The type string: DIODE, ACR, PTC100, PTC1K, NTC10UA, TC70 or NONE

Throws:

org.lsst.ccs.drivers.commons.DriverException

setToControl

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

Sets the device to control the temperature

Throws:

org.lsst.ccs.drivers.commons.DriverException

stopControl

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

Sets the device to stop temperature control

Throws:

org.lsst.ccs.drivers.commons.DriverException

isInControl

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

Gets whether the device is controlling the temperature

Returns:

Whether device is in control

Throws:

org.lsst.ccs.drivers.commons.DriverException

getControl

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

Gets the temperature control state

Returns:

The control state: ON, OFF or OTD

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOtdEnabled

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

Gets whether Over Temperature Disconnect (OTD) is enabled

Returns:

Whether OTD is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableOtd

public void enableOtd(boolean enab)
               throws org.lsst.ccs.drivers.commons.DriverException

Sets whether Over Temperature Disconnect (OTD) is enabled

Parameters:

enab - Whether OTD is to be enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOtdSource

public char getOtdSource()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the OTD source channel

Returns:

The channel ID

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOtdSource

public void setOtdSource(char channel)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the OTD source channel

Parameters:

channel - The channel ID (A-D)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOtdTemp

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

Gets the OTD temperature limit

Returns:

The temperature, in source channel units

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOtdTemp

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

Sets the OTD temperature limit

Parameters:

temp - The temperature, in source channel units

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

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

Reads a string response after sending a command. Overrides the Scpi method in order to do specific error checking

Overrides:

readString in class org.lsst.ccs.drivers.scpi.Scpi

Parameters:

cmnd - The command to send

Returns:

The response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCommand

public void writeCommand(String cmnd)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sends a command. Overrides the Scpi method in order to do specific error checking

Overrides:

writeCommand in class org.lsst.ccs.drivers.scpi.Scpi

Parameters:

cmnd - The command to send

Throws:

org.lsst.ccs.drivers.commons.DriverException