org.lsst.ccs.drivers.ascii

Class Ascii

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class Ascii
extends Object
implements org.lsst.ccs.drivers.commons.DriverConstants

General access routines for a device using Ascii commands.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ascii.DataBits Data characteristics - number of data bits
static class	Ascii.FlowCtrl Data characteristics - flow control
static class	Ascii.Option Constructor options
static class	Ascii.Parity Data characteristics - parity
static class	Ascii.StopBits Data characteristics - number of stop bits
static class	Ascii.Terminator Command or response terminators

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.commons.DriverConstants

org.lsst.ccs.drivers.commons.DriverConstants.ConnType

Constructor Summary

Constructors

Constructor and Description
Ascii() Constructor.
Ascii(Ascii.Option option) Deprecated.

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.
int	getTimeout() Gets the read timeout.
boolean	isOpen() Tests whether the device connection is open.
static int	makeDataCharacteristics(Ascii.DataBits dataBits, Ascii.StopBits stopBits, Ascii.Parity parity, Ascii.FlowCtrl flowCtrl) Generates the serial data characteristics parameter.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident) Opens a connection to the device with default parameters.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int parm) Opens a connection to the device with default data characteristics.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int parm1, int parm2) Opens a connection to the device.
void	openFtdi(String serialNo) Opens a connection to an FTDI device with default parameters.
void	openFtdi(String serialNo, int baudRate) Opens a connection to an FTDI device with default data characteristics.
void	openFtdi(String serialNo, int baudRate, int dataChar) Opens a connection to an FTDI device.
void	openNet(String host) Opens a connection to a network device with default port.
void	openNet(String host, int port) Opens a connection to a network device.
void	openSerial(String devcName) Opens a connection to a serial device with default parameters.
void	openSerial(String devcName, int baudRate) Opens a connection to a serial device with default data characteristic.
void	openSerial(String devcName, int baudRate, int dataChar) 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	setDefaultParm(int parm1) Set the default parameter.
void	setMultidrop() Set multidrop connection.
void	setOptions(Ascii.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

Constructor Detail

Ascii

public Ascii()

Constructor.

Ascii

@Deprecated
public Ascii(Ascii.Option option)

Deprecated.

Constructor (deprecated).

Parameters:

option - Various options

Method Detail

setOptions

public void setOptions(Ascii.Option option)

Sets the options.

Parameters:

option - Various options

setDefaultParm

public void setDefaultParm(int parm1)

Set the default parameter.

Parameters:

parm1 - Default parm1 value

setMultidrop

public void setMultidrop()

Set multidrop connection.

makeDataCharacteristics

public static int makeDataCharacteristics(Ascii.DataBits dataBits,
                                          Ascii.StopBits stopBits,
                                          Ascii.Parity parity,
                                          Ascii.FlowCtrl flowCtrl)

Generates the serial data characteristics parameter.

Parameters:

dataBits - The enumerated number of data bits

stopBits - The enumerated number of stop bits

parity - The enumerated parity

flowCtrl - The enumerated flow control

Returns:

The encoded data characteristics

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          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: host name or IP address for network; serial number for FTDI device; device name for serial

parm1 - The first device parameter, or 0 for default: port number for network; baud rate for FTDI or serial

parm2 - The second device parameter: unused for network; encoded data characteristics for FTDI or serial: 0 sets 8-bit, no parity, 1 stop bit, no flow control

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident,
                 int parm)
          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: host name or IP address for network; serial number for FTDI device; device name for serial

parm - The device parameter: port number for network; baud rate for FTDI or serial

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                 String ident)
          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: host name or IP address for network; serial number for FTDI device; device name for serial

Throws:

org.lsst.ccs.drivers.commons.DriverException

openNet

public void openNet(String host,
                    int port)
             throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a network device.

Parameters:

host - The host name or IP address

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

openNet

public void openNet(String host)
             throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a network device with default port.

Parameters:

host - The host name or IP address

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

public void openSerial(String devcName,
                       int baudRate,
                       int dataChar)
                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

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

public void openSerial(String devcName,
                       int baudRate)
                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

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

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

Opens a connection to a serial device with default parameters.

Parameters:

devcName - The device name

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

public void openFtdi(String serialNo,
                     int baudRate,
                     int dataChar)
              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

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

public void openFtdi(String serialNo,
                     int baudRate)
              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

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

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

Opens a connection to an FTDI device with default parameters.

Parameters:

serialNo - The USB serial number

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 caused an error

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. The current version accepts only a single-byte or a two-byte terminator. The previous version accepted either a CR or LF as a terminator. But this must remain supported for some time since a given program may contain some code that depends on the old behavior and some that depends on the new. The default behavior will be the old, indicated by a zero- byte terminator. The new behavior will come into effect when the new setReceiveTerm method is called.

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

getTimeout

public int getTimeout()

Gets the read timeout.

Returns:

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