org.lsst.ccs.drivers.scpi

Class ScpiCommSerial

java.lang.Object

org.lsst.ccs.drivers.scpi.ScpiCommSerial

All Implemented Interfaces:

ScpiComm

public class ScpiCommSerial
extends Object
implements ScpiComm

Communications routines for serial SCPI devices.

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
ScpiCommSerial()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection.
void	flush() Flushes any available response data.
void	open(String device, int baud, int dummy) Opens a connection.
int	read(byte[] buff, int offset) Reads available response data.
void	setTimeout(int timeout) Sets the receive timeout.
void	write(byte[] command) Writes a command.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScpiCommSerial

public ScpiCommSerial()

Method Detail

open

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

Opens a connection.

Specified by:

open in interface ScpiComm

Parameters:

device - The device name of the serial port

baud - The baud rate

dummy - Dummy argument

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the connection.

Specified by:

close in interface ScpiComm

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public void write(byte[] command)
           throws org.lsst.ccs.drivers.commons.DriverException

Writes a command.

Specified by:

write in interface ScpiComm

Parameters:

command - The command to write, including the terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

public int read(byte[] buff,
       int offset)
         throws org.lsst.ccs.drivers.commons.DriverException

Reads available response data.

Specified by:

read in interface ScpiComm

Parameters:

buff - The buffer to receive the response data

offset - The offset to the first available byte in the buffer

Returns:

The number of bytes read

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

flush

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

Flushes any available response data.

Specified by:

flush in interface ScpiComm

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

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

Sets the receive timeout.

Specified by:

setTimeout in interface ScpiComm

Parameters:

timeout - The receive timeout (ms). 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException