org.lsst.ccs.drivers.ascii

Class TestAscii

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

public class TestAscii
extends Object

Program to test the Ascii command device driver.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected Ascii	dev

Constructor Summary

Constructors

Constructor and Description
TestAscii() Constructor.
TestAscii(Ascii dev) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Closes connection to a device.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int param) Opens connection to a device.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int baud, Ascii.DataBits dbits, Ascii.StopBits sbits, Ascii.Parity parity, Ascii.FlowCtrl flow) Opens connection to a serially-connected device.
void	openOld(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int param) Opens connection (old-style) to a device.
void	openOld(org.lsst.ccs.drivers.commons.DriverConstants.ConnType type, String ident, int baud, Ascii.DataBits dbits, Ascii.StopBits sbits, Ascii.Parity parity, Ascii.FlowCtrl flow) Opens connection (old-style) to a serially-connected device.
String	read() Reads a response.
String	read(String command) Writes a command and reads the response.
void	setTerm(String term) Sets the command terminator.
void	timeout(double time) Sets the response timeout.
void	write(String command) Writes a command.

Methods inherited from class java.lang.Object

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

Field Detail

dev

protected final Ascii dev

Constructor Detail

TestAscii

public TestAscii()

Constructor.

TestAscii

public TestAscii(Ascii dev)

Constructor.

Parameters:

dev - The device to use

Method Detail

open

@Command(name="open",
         description="Open connection to general device")
public void open(@Argument(name="type",description="Connection type: net, serial or ftdi")
                                                                                                 org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                                                                                                 @Argument(name="ident",description="Device identifier")
                                                                                                 String ident,
                                                                                                 @Argument(name="param",description="Device parameter")
                                                                                                 int param)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device.

Parameters:

type - The connection type

ident - The device identification

param - The device parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

@Command(name="open",
         description="Open connection to serial device")
public void open(@Argument(name="type",description="Connection type: net, serial or ftdi")
                                                                                                org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                                                                                                @Argument(name="ident",description="Device identifier")
                                                                                                String ident,
                                                                                                @Argument(name="baud",description="Baud rate")
                                                                                                int baud,
                                                                                                @Argument(name="dbits",description="The number of data bits")
                                                                                                Ascii.DataBits dbits,
                                                                                                @Argument(name="sbits",description="The number of stop bits")
                                                                                                Ascii.StopBits sbits,
                                                                                                @Argument(name="parity",description="The parity")
                                                                                                Ascii.Parity parity,
                                                                                                @Argument(name="flow",description="The flow control")
                                                                                                Ascii.FlowCtrl flow)
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a serially-connected device.

Parameters:

type - The connection type

ident - The device identification

baud - The baud rate

dbits - The number of data bits (eight or seven)

sbits - The number of stop bits (one or two)

parity - The parity (none, odd, even, mark or space)

flow - The flow control (none, xon, rts or dtr)

Throws:

org.lsst.ccs.drivers.commons.DriverException

openOld

@Command(name="openold",
         description="Open connection to general device")
public void openOld(@Argument(name="type",description="Connection type: net, serial or ftdi")
                                                                                                       org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                                                                                                       @Argument(name="ident",description="Device identifier")
                                                                                                       String ident,
                                                                                                       @Argument(name="param",description="Device parameter")
                                                                                                       int param)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Opens connection (old-style) to a device.

Parameters:

type - The connection type

ident - The device identification

param - The device parameter

Throws:

org.lsst.ccs.drivers.commons.DriverException

openOld

@Command(name="openold",
         description="Open connection to serial device")
public void openOld(@Argument(name="type",description="Connection type: net, serial or ftdi")
                                                                                                      org.lsst.ccs.drivers.commons.DriverConstants.ConnType type,
                                                                                                      @Argument(name="ident",description="Device identifier")
                                                                                                      String ident,
                                                                                                      @Argument(name="baud",description="Baud rate")
                                                                                                      int baud,
                                                                                                      @Argument(name="dbits",description="The number of data bits")
                                                                                                      Ascii.DataBits dbits,
                                                                                                      @Argument(name="sbits",description="The number of stop bits")
                                                                                                      Ascii.StopBits sbits,
                                                                                                      @Argument(name="parity",description="The parity")
                                                                                                      Ascii.Parity parity,
                                                                                                      @Argument(name="flow",description="The flow control")
                                                                                                      Ascii.FlowCtrl flow)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Opens connection (old-style) to a serially-connected device.

Parameters:

type - The connection type

ident - The device identification

baud - The baud rate

dbits - The number of data bits (eight or seven)

sbits - The number of stop bits (one or two)

parity - The parity (none, odd, even, mark or space)

flow - The flow control (none, xon, rts or dtr)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

@Command(name="close",
         description="Close connection to device")
public void close()
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Closes connection to a device.

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

@Command(name="write",
         description="Write command to device")
public void write(@Argument(name="command",description="Command to write")
                                                                                         String command)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Writes a command.

Parameters:

command - The command to send (without terminator)

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(name="read",
         description="Read response from device")
public String read()
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Reads a response.

Returns:

The received response

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(name="read",
         description="Write command and read response")
public String read(@Argument(name="command",description="Command to write")
                                                                                                 String command)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a command and reads the response.

Parameters:

command - The command to send (without terminator)

Returns:

The response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

timeout

@Command(name="timeout",
         description="Set read response timeout")
public void timeout(@Argument(name="time",description="Timeout value (sec)")
                                                                                               double time)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the response timeout.

Parameters:

time - The timeout (secs); 0 means no timeout

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTerm

@Command(name="setterm",
         description="Set command terminator")
public void setTerm(@Argument(name="term",description="Terminator string")
                                                                                            String term)

Sets the command terminator.

Parameters:

term - The terminator to set