org.lsst.ccs.drivers.newportlamp

Class NewportLamp

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.newportlamp.NewportLamp

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

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

General access routines for the NewportLamp device

Author:

Homer Neal and Heather Kelly BNL uses 69911 and Harvard has 69931 69931: 9600 baud, 1 stop bit, no parity

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewportLamp.onOff 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
NewportLamp() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	errorCommand()
boolean	errorOpComplete()
double	getAmps() Gets the NewportLamp amps reading.
double	getCurrentLim()
double	getCurrentPreset()
String	getError()
String	getIdent() Gets the NewportLamp identity.
int	getPowerLim()
int	getPowerPreset()
boolean	getState() required by teststand interface.
String	getStatus() Return the full Status byte.
double	getVolts()
double	getWatts()
void	init() Initializes device.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String devcName, int baudRate, int dataChar) Opens a connection.
boolean	parseErrorCommand(String err) check the error register to see if command error bit is on.
boolean	parseErrorOpComplete(String err) Check the error register to see if Operation Complete bit on.
String	readNewportLamp(String command) Reads a response after writing a command.
void	reset() reset to factory defaults.
void	setCurrentLim(double a)
void	setCurrentPreset(double a)
void	setMode(int mode) sets the mode, 1 is power mode, and 0 is current mode.
void	setPowerLim(int p)
void	setPowerPreset(int p)
void	setState(boolean on) Turns lamp on or off.
boolean	statusCalMode()
boolean	statusComm()
boolean	statusCurrentMode()
boolean	statusExt()
boolean	statusFault()
boolean	statusInterlock()
boolean	statusLampOn()
boolean	statusLimit()
boolean	statusPowerMode()
int	stripError(String err) Return the error register.
int	stripStatus(String status) Strips off "STB" if present and converts hex code to int.

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

NewportLamp

public NewportLamp()

Constructor.

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                 String devcName,
                 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 - identifies type of connection FTDI, SERIAL

devcName - The device name of the serial port

baudRate - The baud rate

dataChar - The data characteristics (not used)

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

public void init()

Initializes device.

getState

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

required by teststand interface.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setState

public void setState(boolean on)
              throws org.lsst.ccs.drivers.commons.DriverException

Turns lamp on or off.

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

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

reset to factory defaults.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getStatus

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

Return the full Status byte.

Throws:

org.lsst.ccs.drivers.commons.DriverException

stripStatus

public int stripStatus(String status)
                throws org.lsst.ccs.drivers.commons.DriverException

Strips off "STB" if present and converts hex code to int.

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusLampOn

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusExt

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusPowerMode

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusCurrentMode

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusCalMode

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusFault

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusComm

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusLimit

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

statusInterlock

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

stripError

public int stripError(String err)
               throws org.lsst.ccs.drivers.commons.DriverException

Return the error register.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getError

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

errorCommand

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

errorOpComplete

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

parseErrorCommand

public boolean parseErrorCommand(String err)
                          throws org.lsst.ccs.drivers.commons.DriverException

check the error register to see if command error bit is on.

Throws:

org.lsst.ccs.drivers.commons.DriverException

parseErrorOpComplete

public boolean parseErrorOpComplete(String err)
                             throws org.lsst.ccs.drivers.commons.DriverException

Check the error register to see if Operation Complete bit on.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getIdent

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

Gets the NewportLamp identity.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAmps

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

Gets the NewportLamp amps reading.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMode

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

sets the mode, 1 is power mode, and 0 is current mode.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVolts

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

getWatts

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrentPreset

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentPreset

public void setCurrentPreset(double a)
                      throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrentLim

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentLim

public void setCurrentLim(double a)
                   throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPowerPreset

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPowerPreset

public void setPowerPreset(int p)
                    throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPowerLim

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPowerLim

public void setPowerLim(int p)
                 throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

readNewportLamp

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

Reads a response after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The command response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException