org.lsst.ccs.drivers.ascii

Class Multidrop

java.lang.Object

org.lsst.ccs.drivers.ascii.Multidrop

public class Multidrop
extends Object

General access routines for a multi-drop device using Ascii commands.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Multidrop.ConnType Connection type
static class	Multidrop.Option Operation options

Field Summary

Fields

Modifier and Type	Field and Description
protected int	address

Constructor Summary

Constructors

Constructor and Description
Multidrop()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the device connection.
boolean	closeSilent() Closes the device connection silently.
void	flush() Flushes any unread data.
Object	getSyncObject() Gets the synchronization object.
boolean	isOpen() Tests whether the device connection is open.
void	open(Multidrop.ConnType type, String ident, int addr) Opens a connection to the device with default parameters.
void	open(Multidrop.ConnType type, String ident, int baudRate, int addr) Opens a connection to the device with default data characteristics.
void	open(Multidrop.ConnType type, String ident, int baudRate, int dataChar, int addr) Opens a connection to the device.
void	openFtdi(String serialNo, int addr) Opens a connection to an FTDI device with default parameters.
void	openFtdi(String serialNo, int baudRate, int addr) Opens a connection to an FTDI device with default data characteristics.
void	openFtdi(String serialNo, int baudRate, int dataChar, int addr) Opens a connection to an FTDI device.
void	openSerial(String devcName, int addr) Opens a connection to a serial device with default parameters.
void	openSerial(String devcName, int baudRate, int addr) Opens a connection to a serial device with default data characteristic.
void	openSerial(String devcName, int baudRate, int dataChar, int addr) Opens a connection to a serial device.
String	read() Reads a terminated response.
String	read(String command) Reads a response after writing a command.
int	readBytes(byte[] buff, int offset) Reads available response data as bytes.
int	readBytes(byte[] buff, int offset, int leng) Reads available response data as bytes.
void	setCommandTerm(Ascii.Terminator term) Sets the command terminator.
void	setDefaultAddress(int addr) Sets the default multi-drop address.
void	setDefaultBaud(int baud) Sets the default baud rate.
void	setOptions(Multidrop.Option option) Sets the options.
void	setResponseTerm(Ascii.Terminator term) Sets the response terminator.
void	setTerminator(Ascii.Terminator term) Sets both the command & response terminators.
void	setTimeout(double time) Sets the read timeout.
void	setTimeout(int time) Sets the read timeout.
void	write(String command) Writes a command.
void	writeBytes(byte[] command) Writes a command as bytes.
void	writeBytes(byte[] command, int offset, int leng) Writes a command as bytes.

Methods inherited from class java.lang.Object

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

Field Detail

address

protected int address

Constructor Detail

Multidrop

public Multidrop()

Method Detail

setOptions

public void setOptions(Multidrop.Option option)

Sets the options.

Parameters:

option - Various options

setDefaultBaud

public void setDefaultBaud(int baud)

Sets the default baud rate.

Parameters:

baud - Default baud rate

setDefaultAddress

public void setDefaultAddress(int addr)

Sets the default multi-drop address.

Parameters:

addr - Default baud rate

open

public void open(Multidrop.ConnType type,
                 String ident,
                 int baudRate,
                 int dataChar,
                 int addr)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device. This is the open method that should be overridden by extending classes. since it is called by all other open methods.

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: serial number for FTDI device; device name for serial

baudRate - The baud rate

dataChar - The encoded data characteristics: 0 sets 8-bit, no parity, 1 stop bit, no flow control

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(Multidrop.ConnType type,
                 String ident,
                 int baudRate,
                 int addr)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device with default data characteristics.

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: serial number for FTDI device; device name for serial

baudRate - The baud rate

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(Multidrop.ConnType type,
                 String ident,
                 int addr)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device with default parameters.

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: serial number for FTDI device; device name for serial

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

public void openSerial(String devcName,
                       int baudRate,
                       int dataChar,
                       int addr)
                throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a serial device.

Parameters:

devcName - The device name

baudRate - The baud rate

dataChar - The encoded data characteristics: 0 sets 8-bit, no parity, 1 stop bit, no flow ctrl

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

public void openSerial(String devcName,
                       int baudRate,
                       int addr)
                throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a serial device with default data characteristic.

Parameters:

devcName - The device name

baudRate - The baud rate

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

public void openSerial(String devcName,
                       int addr)
                throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a serial device with default parameters.

Parameters:

devcName - The device name

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

public void openFtdi(String serialNo,
                     int baudRate,
                     int dataChar,
                     int addr)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to an FTDI device.

Parameters:

serialNo - The USB serial number

baudRate - The baud rate

dataChar - The encoded data characteristics: 0 sets 8-bit, no parity, 1 stop bit, no flow ctrl

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

public void openFtdi(String serialNo,
                     int baudRate,
                     int addr)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to an FTDI device with default data characteristics.

Parameters:

serialNo - The USB serial number

baudRate - The baud rate

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

public void openFtdi(String serialNo,
                     int addr)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to an FTDI device with default parameters.

Parameters:

serialNo - The USB serial number

addr - The multi-drop address

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the device connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

closeSilent

public boolean closeSilent()

Closes the device connection silently.

Returns:

Whether or not the close was successful

isOpen

public boolean isOpen()

Tests whether the device connection is open.

Returns:

Whether or not the connection is open

write

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

Writes a command.

Parameters:

command - The command to write, excluding terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

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

Reads a terminated response.

Returns:

The command response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

read

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

writeBytes

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

Writes a command as bytes.

Parameters:

command - The command to write, including any terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeBytes

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

Writes a command as bytes.

Parameters:

command - The command to write, including any terminator

offset - The offset to the first byte to write

leng - The number of bytes to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBytes

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

Reads available response data as bytes.

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

readBytes

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

Reads available response data as bytes.

Parameters:

buff - The buffer to receive the response data

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

leng - 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 unread data.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setResponseTerm

public void setResponseTerm(Ascii.Terminator term)

Sets the response terminator.

Parameters:

term - The expected terminator for a response (CR, LF or CRLF)

setCommandTerm

public void setCommandTerm(Ascii.Terminator term)

Sets the command terminator.

Parameters:

term - The terminator to be appended to each command (CR, LF or CRLF)

setTerminator

public void setTerminator(Ascii.Terminator term)

Sets both the command & response terminators.

Parameters:

term - The terminator to be used

setTimeout

public void setTimeout(double time)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the read timeout.

Parameters:

time - The read timeout (sec). 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

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

Sets the read timeout.

Parameters:

time - The read timeout (msec). 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSyncObject

public Object getSyncObject()

Gets the synchronization object. Returns an object that can be used to synchronize multiple accesses to the underlying hardware.

Returns:

The synchronization object