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.
protected static String	makeCommandString(String command, String... args) Makes a command string.
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 device with serial data characteristics.
void	openFtdi(String serial, int baud) Opens connection to an FTDI device.
void	openNet(String host, int port) Opens connection to a network device.
void	openSerial(String devc, int baud) Opens connection to a serial device.
String	read() Reads a response.
String	read(String command) Writes a command and reads the response.
void	setCmndTerm(Ascii.Terminator term) Sets the command terminator.
void	setRespTerm(Ascii.Terminator term) Sets the response terminator.
void	setTerminator(Ascii.Terminator term) Sets both the command and response terminators.
void	setTimeout(double time) Sets the response timeout.
void	write(String command, String... args) 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 with serial data characteristics")
public void open(@Argument(name="type",description="Connection type: 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 device with serial data characteristics.

Parameters:

type - The connection type (serial or ftdi)

ident - The device identification (device name or USB serial no.)

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

openNet

@Command(name="opennet",
         description="Open connection to network device")
public void openNet(@Argument(name="host",description="Host name")
                                                                                                       String host,
                                                                                                       @Argument(name="port",description="Port number")
                                                                                                       int port)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a network device.

Parameters:

host - The host name

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

openSerial

@Command(name="openserial",
         description="Open connection to serial device")
public void openSerial(@Argument(name="devc",description="Device name")
                                                                                                            String devc,
                                                                                                            @Argument(name="baud",description="Baud rate")
                                                                                                            int baud)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a serial device.

Parameters:

devc - The device name

baud - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

openFtdi

@Command(name="openftdi",
         description="Open connection to FTDI device")
public void openFtdi(@Argument(name="serial",description="USB serial number")
                                                                                                      String serial,
                                                                                                      @Argument(name="baud",description="Baud rate")
                                                                                                      int baud)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to an FTDI device.

Parameters:

serial - The USB serial number

baud - The baud rate

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 word")
                                                                                         String command,
                                                                                         @Argument(name="args",description="Arguments")
                                                                                         String... args)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Writes a command.

Parameters:

command - The command word to send

args - The arguments

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 send")
                                                                                                 String command)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a command and reads the response.

Parameters:

command - The command to send

Returns:

The response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

@Command(name="settimeout",
         description="Set read response timeout")
public void setTimeout(@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

setCmndTerm

@Command(name="setcmndterm",
         description="Set command terminator")
public void setCmndTerm(@Argument(name="term",description="Terminator enum")
                                                                                                    Ascii.Terminator term)

Sets the command terminator.

Parameters:

term - The terminator to set

setRespTerm

@Command(name="setrespterm",
         description="Set response terminator")
public void setRespTerm(@Argument(name="term",description="Terminator enum")
                                                                                                     Ascii.Terminator term)

Sets the response terminator.

Parameters:

term - The terminator to set

setTerminator

@Command(name="setterm",
         description="Set both terminators")
public void setTerminator(@Argument(name="term",description="Terminator enum")
                                                                                                Ascii.Terminator term)

Sets both the command and response terminators.

Parameters:

term - The terminator to set

makeCommandString

protected static String makeCommandString(String command,
                                          String... args)

Makes a command string.

Parameters:

command - The command word

args - The command arguments

Returns:

The generated command string