org.lsst.ccs.drivers.ascii

Class Ascii

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

public class Ascii
extends Object

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.ConnType Connection type
static class	Ascii.DataBits Data characteristics - number of data bits
static class	Ascii.FlowCtrl Data characteristics - flow control
static class	Ascii.Option Connection type
static class	Ascii.Parity Data characteristics - parity
static class	Ascii.StopBits Data characteristics - number of stop bits

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONN_TYPE_FTDI Connection type - serial via FTDI chip
static int	CONN_TYPE_NETWORK Connection type - network
static int	CONN_TYPE_SERIAL Connection type - serial via serial port

Constructor Summary

Constructors

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

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.
static int	makeDataCharacteristics(Ascii.DataBits dataBits, Ascii.StopBits stopBits, Ascii.Parity parity, Ascii.FlowCtrl flowCtrl) Generates the serial data characteristics parameter.
void	open(Ascii.ConnType type, String ident, int parm) Opens a connection to the device.
void	open(Ascii.ConnType type, String ident, int parm1, int parm2) Opens a connection to the device.
void	open(int type, String ident, int parm) Deprecated.
void	open(int type, String ident, int parm1, int parm2) Deprecated.
String	read() Reads a 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	setTerminator(String term) Sets the command terminator.
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

CONN_TYPE_NETWORK

public static final int CONN_TYPE_NETWORK

Connection type - network

See Also:

Constant Field Values

CONN_TYPE_FTDI

public static final int CONN_TYPE_FTDI

Connection type - serial via FTDI chip

See Also:

Constant Field Values

CONN_TYPE_SERIAL

public static final int CONN_TYPE_SERIAL

Connection type - serial via serial port

See Also:

Constant Field Values

Constructor Detail

Ascii

public Ascii()

Constructor.

Ascii

public Ascii(Ascii.Option option)

Constructor.

Parameters:

option - Disallowed connections option

Method Detail

open

public void open(Ascii.ConnType type,
                 String ident,
                 int parm1,
                 int parm2)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to the device.

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: host name or IP address for network; [node:]serial number for FTDI device; device name for serial

parm1 - The first device parameter: 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 ctrl

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Opens a connection to the device.

Parameters:

type - The enumerated type of connection to make

ident - The device identifier: host name or IP address for network; [node:]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

@Deprecated
public final void open(int type,
                                   String ident,
                                   int parm1,
                                   int parm2)
                            throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Opens a connection to the device.

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; [node:]serial number for FTDI device; device name for serial

parm1 - The first device parameter: 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 ctrl

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

@Deprecated
public void open(int type,
                             String ident,
                             int parm)
                      throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Opens a connection to the device.

Parameters:

type - The type of connection to make

ident - The device identifier: host name or IP address for network; [node:]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

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

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

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 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

setTerminator

public void setTerminator(String term)

Sets the command terminator.

Parameters:

term - The terminator to be appended to each sent command

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