org.lsst.ccs.drivers.ascii

Class AsciiIOFtdi

java.lang.Object

org.lsst.ccs.drivers.ascii.AsciiIOFtdi

All Implemented Interfaces:

AsciiIO

public class AsciiIOFtdi
extends Object
implements AsciiIO

Communications I/O routines for serial devices connected via FTDI.

Author:

Owen Saxton

Constructor Summary

Constructors

Constructor and Description
AsciiIOFtdi()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AsciiIOFtdi

public AsciiIOFtdi()

Method Detail

open

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

Opens a connection.

Specified by:

open in interface AsciiIO

Parameters:

serial - The serial number string of the interface, optionally prepended with the node name of a remote FTDI server, and separated from it by a ":".

baud - The baud rate

dchars - The data characteristics

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 AsciiIO

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

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

Writes command data.

Specified by:

write in interface AsciiIO

Parameters:

buff - The buffer containing the command to write

offset - The offset to the command

leng - The length of the command

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

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

Reads available response data.

Specified by:

read in interface AsciiIO

Parameters:

buff - The buffer to receive the response data

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

mleng - The maximum number of bytes to read

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 AsciiIO

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 AsciiIO

Parameters:

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

Throws:

org.lsst.ccs.drivers.commons.DriverException