org.lsst.ccs.drivers.orielshutter

Class OrielShutter

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.orielshutter.OrielShutter

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

General access routines for the Oriel Shutter device

Author:

Homer Neal **************************************************************************

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrielShutter.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.Parity, org.lsst.ccs.drivers.ascii.Ascii.StopBits

Field Summary

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
OrielShutter()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
void	closeShutter()
String	getIdent() Gets the OrielShutter identity.
void	init() Initializes device.
void	open(String serialname, int port, int addr) Opens a connection.
void	openftdi(String serialname, int baud, int addr) Opens an FTDI connection.
void	openShutter()
String	readOrielShutter() Reads a response.
String	readOrielShutter(String command) Reads a response after writing a command.
void	reset() reset to factory defaults
void	setTimeout(int timeout) Sets the receive timeout.
void	writeOrielShutter(String command) Writes a command.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

OrielShutter

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

open

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

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

Parameters:

baud - The baud rate

dummy - Dummy argument * * @throws DriverException *

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

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

Opens an FTDI connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

public void init()

Initializes device.

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

reset

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

reset to factory defaults

Throws:

org.lsst.ccs.drivers.commons.DriverException

getIdent

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

Gets the OrielShutter identity.

Throws:

org.lsst.ccs.drivers.commons.DriverException

openShutter

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

closeShutter

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

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

Sets the receive timeout. * * @param timeout The receive timeout (ms). 0 means no timeout. * * @throws DriverException *

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOrielShutter

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

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

readOrielShutter

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

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

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - *

org.lsst.ccs.drivers.commons.DriverException

readOrielShutter

public String readOrielShutter(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

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - *

org.lsst.ccs.drivers.commons.DriverException