org.lsst.ccs.drivers.lakeshore

Class LS330

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.lakeshore.LS330

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

General access routines for the LakeShore 330 Temperature device

Author:

Peter Doherty and Heather Kelly Manual indicates baud rates of 300,1200 Software timing 1 start, 7 data, 1 parity, 1 stop Odd parity Baud 300 or 1200 Terminator: CR(0DH) LF(0AH) Manual indicates that when using the serial connection, the only "common" commands available are *IDN? and *RST, see page 4-7 The device powers on into LOCal mode. **************************************************************************

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LS330.HeaterRange
static class	LS330.Modes
static class	LS330.onOff

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

org.lsst.ccs.drivers.ascii.Ascii.ConnType, 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_LOCAL Public constants *
static int	MODE_REMOTE Public constants *
static int	MODE_REMOTEWITHLOCKOUT Public constants *

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

CONN_TYPE_FTDI, CONN_TYPE_NETWORK, CONN_TYPE_SERIAL

Constructor Summary

Constructors

Constructor and Description
LS330()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
String	getControlChannel() Get the Lakeshore 330 control channel Communication with instrument: CCHN? Control Channel Query.
Double	getControlData() Get the Lakeshore 330 control channel data measurement Communication with instrument: CDAT? Sample Sensor Data Query.
String	getControlUnits() Get the Lakeshore 330 control loop temperature units Communication with instrument: CUNI? Control Units Query.
double	getHeater() Gets the Lakeshore 330 heater current Communication with instrument: HEAT? Heater Output Query Input: HTR? loop[term] Returned: heater_value[term] Format: +nnn.n heater_value: heater output in percent (%) of current or power, depending on setting.
int	getHeaterRange() Gets the Lakeshore 330 heater range RANG? Heater Range Query Input: RANGE? loop[term] Format: n Returned: range[term] Format: n (Refer to command for description)
String	getIdent() Get the Lakeshore 330 identity.
String	getMode()
String	getSampleChannel() Get the Lakeshore 330 sample channel Communication with instrument: CCHN? Control Channel Query.
Double	getSampleData() Get the Lakeshore 330 sample channel data measurement Communication with instrument: SDAT? Sample Sensor Data Query.
String	getSampleUnits() Gets the Lakeshore 330 sample channel temperature units Communication with instrument: SUNI? Sample Units Query.
double	getSetpoint() Get the Lakeshore 330 temperature set point Communication with instrument: SETP? Control Setpoint Query Command: SETP?[term] Returned: value[term] Format: ±nnnnnn
void	init() Initializes device.
boolean	isInControl() isInControl Autotuning status query, 0 = Manual, 1 = P, 2 = PI, and 3 = PID
void	open(String serialname, int baud) Opens a connection.
void	openftdi(String serialname, int baud) Opens an FTDI connection.
String	readLS330() Reads a response.
String	readLS330(String command) Reads a response after writing a command.
void	reset()
void	setControlChannel(String chan) Sets the Lakeshore 330 control channel Communication with instrument: CCHN Set Control Channel to A or B.
void	setControlUnits(String unitstr) Sets the Lakeshore 330 units Communication with instrument: CUNI Set Units for the Control Channel.
void	setFakeout(Boolean flag) set Fakeout true or false
void	setHeaterRange(int range) Sets the Lakeshore 330 heater range Communication with instrument: RANGE Heater Range Command Input: RANG range[term] Format: n,n range: 0 = Off, 1 = Low, 2 = Medium, 3 = High
void	setMode(LS330.Modes mode)
void	setSampleChannel(String chan) Sets the Lakeshore 330 sample channel Communication with instrument: SCHN Set Sample Channel to A or B.
void	setSampleUnits(String unitstr) Sets the Lakeshore 330 sample channel units Communication with instrument: SUNI Set Units for the Sample Channel.
void	setSetpoint(double setp) Sets the Lakeshore 330 temperature set point Communication with instrument: SETP Control Setpoint Command Command: SETP value[term] Format: n,±nnnnnn value: The value for the setpoint (in whatever units the device is using).
void	setTimeout(int timeout) Sets the receive timeout.
void	setTracedebug(Boolean flag) set TraceDebug true or false
void	setVerbose(Boolean flag) set Verbosity
void	writeLS330(String command) Writes a command.

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

closeSilent, flush, makeDataCharacteristics, open, open, open, open, read, read, readBytes, readBytes, setTerminator, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Field Detail

MODE_LOCAL

public static final int MODE_LOCAL

Public constants *

See Also:

Constant Field Values

MODE_REMOTE

public static final int MODE_REMOTE

Public constants *

See Also:

Constant Field Values

MODE_REMOTEWITHLOCKOUT

public static final int MODE_REMOTEWITHLOCKOUT

Public constants *

See Also:

Constant Field Values

Constructor Detail

LS330

public LS330()
      throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

open

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

Opens a connection. * * @param device The device name of the serial port

Parameters:

serialname -

baud -

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

public void openftdi(String serialname,
                     int baud)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens an FTDI connection.

Parameters:

serialname -

baud -

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

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

Initializes device. Also sets up some standard settings Celcius for temperature Control channel A set point -95. Heater range 3 (high)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the connection. * * @throws DriverException *

Overrides:

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVerbose

public void setVerbose(Boolean flag)
                throws org.lsst.ccs.drivers.commons.DriverException

set Verbosity

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTracedebug

public void setTracedebug(Boolean flag)
                   throws org.lsst.ccs.drivers.commons.DriverException

set TraceDebug true or false

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFakeout

public void setFakeout(Boolean flag)
                throws org.lsst.ccs.drivers.commons.DriverException

set Fakeout true or false

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

public void setTimeout(int timeout)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the receive timeout. * 0 means no timeout. * * @throws DriverException *

Overrides:

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

Parameters:

timeout - The receive timeout (ms).

Throws:

org.lsst.ccs.drivers.commons.DriverException

getIdent

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

Get the Lakeshore 330 identity. Communication with instrument: IDN? Identification Query Input: *IDN?[term] Returned: manufacturer,model,serial,firmware_version[term] Format: aaaa,aaaaaaaa,aaaaaaa,n.n/n.n manufacture: Manufacturer ID model: Instrument model number serial: Serial number fw version: Instrument firmware version, main firmware/input firmware. Example: LSCI,MODEL330,1234567,1.0/1.0

Returns:

Instrument identity string

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMode

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMode

public void setMode(LS330.Modes mode)
             throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSetpoint

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

Get the Lakeshore 330 temperature set point Communication with instrument: SETP? Control Setpoint Query Command: SETP?[term] Returned: value[term] Format: ±nnnnnn

Returns:

Current setpoint

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSetpoint

public void setSetpoint(double setp)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the Lakeshore 330 temperature set point Communication with instrument: SETP Control Setpoint Command Command: SETP value[term] Format: n,±nnnnnn value: The value for the setpoint (in whatever units the device is using). Example: SETP -95.0[term]

Parameters:

setp - Value (in current units) for temperature set point

Throws:

org.lsst.ccs.drivers.commons.DriverException

getControlChannel

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

Get the Lakeshore 330 control channel Communication with instrument: CCHN? Control Channel Query. Input: CCHN? Returned: A or B Remarks: Returns the current control channel setting: A = channel A, B = channel B.

Returns:

channel string: A or B

Throws:

org.lsst.ccs.drivers.commons.DriverException

setControlChannel

public void setControlChannel(String chan)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the Lakeshore 330 control channel Communication with instrument: CCHN Set Control Channel to A or B. Input: CCHN A, or CCHN B Returned: Nothing Remarks: Sets control channel to sensor A or B. Example: CCHN A[term] changes the control channel to A.

Parameters:

chan - The channel to use for control: A or B

Throws:

org.lsst.ccs.drivers.commons.DriverException

getControlUnits

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

Get the Lakeshore 330 control loop temperature units Communication with instrument: CUNI? Control Units Query. Input: CUNI? Returned: K, C, V, R, or M Remarks: Current control units setting: K = kelvin, C = Celsius, V = volts, R = Ohms, M = millivolts. (should not see last three)

Returns:

units string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setControlUnits

public void setControlUnits(String unitstr)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the Lakeshore 330 units Communication with instrument: CUNI Set Units for the Control Channel. Input: CUNI K, CUNI C Returned: Nothing Remarks: Set control channel units: K = kelvin, C = Celsius Note: This software does not allow for 'sensor' units

Parameters:

unitstr - units string: 'K' = kelvin, 'C' = Celsius

Throws:

org.lsst.ccs.drivers.commons.DriverException

getControlData

public Double getControlData()
                      throws org.lsst.ccs.drivers.commons.DriverException

Get the Lakeshore 330 control channel data measurement Communication with instrument: CDAT? Sample Sensor Data Query. Input: CDAT? Returned: ±000.00 Remarks: Returns sample sensor data. The value returned is 7 characters: a sign, 5 digits and a decimal point. The last digit may be a null. Example: -123.40[term] Typical response for degrees Celsius +234.50[term] Typical response for kelvin or Celsius

Returns:

measured temperature in current units

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSampleChannel

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

Get the Lakeshore 330 sample channel Communication with instrument: CCHN? Control Channel Query. Input: CCHN? Returned: A or B Remarks: Returns the current control channel setting: A = channel A, B = channel B.

Returns:

channel string: A or B

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSampleChannel

public void setSampleChannel(String chan)
                      throws org.lsst.ccs.drivers.commons.DriverException

Sets the Lakeshore 330 sample channel Communication with instrument: SCHN Set Sample Channel to A or B. Input: SCHN A, or SCHN B Returned: Nothing Remarks: Sets the sample channel to sensor A or B. Example: SCHN A[term] changes the sample channel to A.

Parameters:

chan - The channel to use for sampling: A or B

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSampleUnits

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

Gets the Lakeshore 330 sample channel temperature units Communication with instrument: SUNI? Sample Units Query. Input: SUNI? Returned: K, C, V, R, or M Remarks: Current control units setting: K = kelvin, C = Celsius, V = volts, R = Ohms, M = millivolts. (should not see last three)

Returns:

units string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSampleUnits

public void setSampleUnits(String unitstr)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the Lakeshore 330 sample channel units Communication with instrument: SUNI Set Units for the Sample Channel. Input: SUNI K, SUNI C Returned: Nothing Remarks: Set control channel units: K = kelvin, C = Celsius Note: This software does not allow for 'sensor' units

Parameters:

unitstr - units string: 'K' = kelvin, 'C' = Celsius

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSampleData

public Double getSampleData()
                     throws org.lsst.ccs.drivers.commons.DriverException

Get the Lakeshore 330 sample channel data measurement Communication with instrument: SDAT? Sample Sensor Data Query. Input: SDAT? Returned: ±000.00 Remarks: Returns sample sensor data. The value returned is 7 characters: a sign, 5 digits and a decimal point. The last digit may be a null. Example: -123.40[term] Typical response for degrees Celsius +234.50[term] Typical response for kelvin or Celsius

Returns:

measured temperature in current units

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeater

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

Gets the Lakeshore 330 heater current Communication with instrument: HEAT? Heater Output Query Input: HTR? loop[term] Returned: heater_value[term] Format: +nnn.n heater_value: heater output in percent (%) of current or power, depending on setting.

Returns:

the heater power %

Throws:

org.lsst.ccs.drivers.commons.DriverException

getHeaterRange

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

Gets the Lakeshore 330 heater range RANG? Heater Range Query Input: RANGE? loop[term] Format: n Returned: range[term] Format: n (Refer to command for description)

Returns:

the heater range: 0 = off, 1 = low, 2 = medium, 3 = high

Throws:

org.lsst.ccs.drivers.commons.DriverException

isInControl

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

isInControl Autotuning status query, 0 = Manual, 1 = P, 2 = PI, and 3 = PID

Throws:

org.lsst.ccs.drivers.commons.DriverException

setHeaterRange

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

Sets the Lakeshore 330 heater range Communication with instrument: RANGE Heater Range Command Input: RANG range[term] Format: n,n range: 0 = Off, 1 = Low, 2 = Medium, 3 = High

Parameters:

range - Specifies the control mode. Valid entries: For loop 1: 0 = Off, 1 = Low (2.5 W), 2 = High (25 W) For loop 2: 0 = Off, 1 = On

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeLS330

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

Writes a command. * * @param command The command to write, excluding terminator * * @throws DriverE

Parameters:

command - a command string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readLS330

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

Reads a response. * * @return The command response string * * @throws DriverException

Returns:

the response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readLS330

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

Reads a response after writing a command. * * @param command The command to write, excluding terminator * * @return The command response string * * @throws DriverException

Parameters:

command - command string

Returns:

response string

Throws:

org.lsst.ccs.drivers.commons.DriverException