org.lsst.ccs.drivers.ftdi

Class Ftdi

java.lang.Object

org.lsst.ccs.drivers.ftdi.Ftdi

All Implemented Interfaces:

FtdiInterface

public class Ftdi
extends Object
implements FtdiInterface

Accesses a device which uses the FTDI chip.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATABITS_7 Word length value: 7 bits
static int	DATABITS_8 Word length value: 8 bits
static int	EVENT_LINE_STATUS Event type: line status changed
static int	EVENT_MODEM_STATUS Event type: modem status changed
static int	EVENT_RXCHAR Event type: character received
static int	FLOW_CONTROL_DTR_DSR Flow control value: DTR/DSR
static int	FLOW_CONTROL_NONE Flow control value: none
static int	FLOW_CONTROL_RTS_CTS Flow control value: RTS/CTS
static int	FLOW_CONTROL_XON_XOFF Flow control value: XON/XOFF
static int	MODEM_STATUS_CTS Modem status bit: CTS
static int	MODEM_STATUS_DCD Modem status bit: DCD
static int	MODEM_STATUS_DSR Modem status bit: DSR
static int	MODEM_STATUS_RI Modem status bit: RI
static int	PARITY_EVEN Parity value: even
static int	PARITY_MARK Parity value: mark
static int	PARITY_NONE Parity value: none
static int	PARITY_ODD Parity value: odd
static int	PARITY_SPACE Parity value: space
static int	STOPBITS_1 Stop bits value: 1
static int	STOPBITS_2 Stop bits value: 2

Constructor Summary

Constructors

Constructor and Description
Ftdi()

Method Summary

Modifier and Type	Method and Description
int	awaitEvent(int timeout) Waits for an event.
void	close() Closes the device.
void	enableEvents(int mask) Enables events.
int	getModemStatus() Gets the modem status.
int	getQueueStatus() Gets the read queue status.
void	open(int index, String serial) Opens a local device.
void	open(String node, int index, String serial) Opens a local or remote device.
int	read(byte[] data) Reads data.
int	read(byte[] data, int offset, int count) Reads data.
void	setBaudrate(int baudrate) Sets the baud rate.
void	setDataCharacteristics(int wordLength, int stopBits, int parity) Sets the data characteristics.
void	setDtr(boolean set) Sets the state of the DTR line.
void	setFlowControl(int flow) Sets the flow control.
void	setRts(boolean set) Sets the state of the RTS line.
void	setTimeouts(int rcveTimeout, int xmitTimeout) Sets the timeouts.
int	write(byte[] data) Writes data.
int	write(byte[] data, int offset, int count) Writes data.

Methods inherited from class java.lang.Object

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

Field Detail

DATABITS_8

public static final int DATABITS_8

Word length value: 8 bits

See Also:

Constant Field Values

DATABITS_7

public static final int DATABITS_7

Word length value: 7 bits

See Also:

Constant Field Values

STOPBITS_1

public static final int STOPBITS_1

Stop bits value: 1

See Also:

Constant Field Values

STOPBITS_2

public static final int STOPBITS_2

Stop bits value: 2

See Also:

Constant Field Values

PARITY_NONE

public static final int PARITY_NONE

Parity value: none

See Also:

Constant Field Values

PARITY_ODD

public static final int PARITY_ODD

Parity value: odd

See Also:

Constant Field Values

PARITY_EVEN

public static final int PARITY_EVEN

Parity value: even

See Also:

Constant Field Values

PARITY_MARK

public static final int PARITY_MARK

Parity value: mark

See Also:

Constant Field Values

PARITY_SPACE

public static final int PARITY_SPACE

Parity value: space

See Also:

Constant Field Values

MODEM_STATUS_CTS

public static final int MODEM_STATUS_CTS

Modem status bit: CTS

See Also:

Constant Field Values

MODEM_STATUS_DSR

public static final int MODEM_STATUS_DSR

Modem status bit: DSR

See Also:

Constant Field Values

MODEM_STATUS_RI

public static final int MODEM_STATUS_RI

Modem status bit: RI

See Also:

Constant Field Values

MODEM_STATUS_DCD

public static final int MODEM_STATUS_DCD

Modem status bit: DCD

See Also:

Constant Field Values

FLOW_CONTROL_NONE

public static final int FLOW_CONTROL_NONE

Flow control value: none

See Also:

Constant Field Values

FLOW_CONTROL_RTS_CTS

public static final int FLOW_CONTROL_RTS_CTS

Flow control value: RTS/CTS

See Also:

Constant Field Values

FLOW_CONTROL_DTR_DSR

public static final int FLOW_CONTROL_DTR_DSR

Flow control value: DTR/DSR

See Also:

Constant Field Values

FLOW_CONTROL_XON_XOFF

public static final int FLOW_CONTROL_XON_XOFF

Flow control value: XON/XOFF

See Also:

Constant Field Values

EVENT_RXCHAR

public static final int EVENT_RXCHAR

Event type: character received

See Also:

Constant Field Values

EVENT_MODEM_STATUS

public static final int EVENT_MODEM_STATUS

Event type: modem status changed

See Also:

Constant Field Values

EVENT_LINE_STATUS

public static final int EVENT_LINE_STATUS

Event type: line status changed

See Also:

Constant Field Values

Constructor Detail

Ftdi

public Ftdi()

Method Detail

open

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

Opens a local device.

Specified by:

open in interface FtdiInterface

Parameters:

index - The zero-based index of the FTDI device within the list selected by the serial argument.

serial - A string which, if non-null and non-empty, restricts the list of available devices to those with a serial number containing this string.

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Opens a local or remote device.

Specified by:

open in interface FtdiInterface

Parameters:

node - The name of the node where the device is located, or null to specify a local device.

index - The zero-based index of the FTDI device within the list selected by the serial argument.

serial - A string which, if non-null and non-empty, restricts the list of available devices to those with a serial number containing this string.

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the device.

Specified by:

close in interface FtdiInterface

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBaudrate

public void setBaudrate(int baudrate)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the baud rate.

Specified by:

setBaudrate in interface FtdiInterface

Parameters:

baudrate - The baud rate to set.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDataCharacteristics

public void setDataCharacteristics(int wordLength,
                                   int stopBits,
                                   int parity)
                            throws org.lsst.ccs.drivers.commons.DriverException

Sets the data characteristics.

Specified by:

setDataCharacteristics in interface FtdiInterface

Parameters:

wordLength - The encoded word length to set.

stopBits - The encoded number of stop bits to set.

parity - The encoded parity value to set.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFlowControl

public void setFlowControl(int flow)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the flow control.

Specified by:

setFlowControl in interface FtdiInterface

Parameters:

flow - The encoded flow control value to set.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeouts

public void setTimeouts(int rcveTimeout,
                        int xmitTimeout)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the timeouts.

Specified by:

setTimeouts in interface FtdiInterface

Parameters:

rcveTimeout - The receive timeout to set (ms). A value of 0 means no timeout.

xmitTimeout - The transmit timeout to set (ms). A value of 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDtr

public void setDtr(boolean set)
            throws org.lsst.ccs.drivers.commons.DriverException

Sets the state of the DTR line.

Specified by:

setDtr in interface FtdiInterface

Parameters:

set - True to set the line; false to clear it.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRts

public void setRts(boolean set)
            throws org.lsst.ccs.drivers.commons.DriverException

Sets the state of the RTS line.

Specified by:

setRts in interface FtdiInterface

Parameters:

set - True to set the line; false to clear it.

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableEvents

public void enableEvents(int mask)
                  throws org.lsst.ccs.drivers.commons.DriverException

Enables events.

Specified by:

enableEvents in interface FtdiInterface

Parameters:

mask - Bit mask of events to be enabled.

Throws:

org.lsst.ccs.drivers.commons.DriverException

awaitEvent

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

Waits for an event.

Specified by:

awaitEvent in interface FtdiInterface

Parameters:

timeout - The maximum time (msec) to wait; 0 means no timeout.

Returns:

The bit mask of events that occurred.

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

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

Reads data. Execution is blocked until either the byte array is filled, or a timeout occurs. In the latter case the number of bytes read will be less than the array size.

Specified by:

read in interface FtdiInterface

Parameters:

data - A byte array to receive the read data.

Returns:

The number of bytes read.

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

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

Reads data. Execution is blocked until either the requested number of bytes has been read, or a timeout occurs. In the latter case the number of bytes read will be less than the requested number.

Specified by:

read in interface FtdiInterface

Parameters:

data - A byte array to receive the read data.

offset - The offset in the array to the start of the data.

count - The maximum number of bytes to read.

Returns:

The number of bytes read.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public int write(byte[] data)
          throws org.lsst.ccs.drivers.commons.DriverException

Writes data.

Specified by:

write in interface FtdiInterface

Parameters:

data - A byte array containing the data to write.

Returns:

The number of bytes written.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

public int write(byte[] data,
                 int offset,
                 int count)
          throws org.lsst.ccs.drivers.commons.DriverException

Writes data.

Specified by:

write in interface FtdiInterface

Parameters:

data - A byte array containing the data to write.

offset - The offset in the array to the start of the data.

count - The number of bytes to write.

Returns:

The number of bytes written.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getQueueStatus

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

Gets the read queue status. This is the number of bytes available for immediate read, without execution being blocked.

Specified by:

getQueueStatus in interface FtdiInterface

Returns:

The number of bytes in the read queue.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getModemStatus

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

Gets the modem status.

Specified by:

getModemStatus in interface FtdiInterface

Returns:

The modem status as a set of bits.

Throws:

org.lsst.ccs.drivers.commons.DriverException