org.lsst.ccs.drivers.scpi

Class TestScpi

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.scpi.TestScpi

public class TestScpi
extends org.lsst.ccs.drivers.ascii.TestAscii

Program to test the SCPI device driver

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected Scpi	scpi

Fields inherited from class org.lsst.ccs.drivers.ascii.TestAscii

dev

Constructor Summary

Constructors

Constructor and Description
TestScpi() Constructor.
TestScpi(Scpi scpi) Constructor.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears saved status.
void	enableOpc() Enables operation complete reporting.
double	readDouble(String command, String... args) Writes a command with error checking and reads the double response.
float	readFloat(String command, String... args) Writes a command with error checking and reads the float response.
int	readInteger(String command, String... args) Writes a command with error checking and reads the integer response.
String	readString(String command, String... args) Writes a command with error checking and reads the string response.
void	reset() Resets to power-on state.
int	selfTest() Runs the self test.
void	setEse(int value) Sets the event status enable register.
void	setSre(int value) Sets the service request enable register.
String	showError() Displays the first error item.
String	showEse() Displays the event status enable register.
String	showEsr() Displays the event status register.
String	showIdentification() Displays SCPI device identification.
int	showOpc() Displays the operation complete state.
String	showSre() Displays the service request enable register.
String	showStatus() Displays the status byte.
void	waitComp() Waits for command completion.
void	writeCommand(String command, String... args) Writes a command with error checking.

Methods inherited from class org.lsst.ccs.drivers.ascii.TestAscii

close, makeCommandString, open, open, open, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, read, read, setCmndTerm, setDefaultParm, setOptions, setRespTerm, setTerminator, setTimeout, write

Methods inherited from class java.lang.Object

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

Field Detail

scpi

protected final Scpi scpi

Constructor Detail

TestScpi

public TestScpi()

Constructor.

TestScpi

public TestScpi(Scpi scpi)

Constructor.

Parameters:

scpi - The SCPI device to use

Method Detail

writeCommand

@Command(name="writecommand",
         description="Write command")
public void writeCommand(@Argument(description="Command word")
                                                                                             String command,
                                                                                             @Argument(description="Arguments")
                                                                                             String... args)
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with error checking.

Parameters:

command - The command word

args - The command arguments

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

@Command(name="readstring",
         description="Write command and read string response")
public String readString(@Argument(description="Command word")
                                                                                                                    String command,
                                                                                                                    @Argument(description="Arguments")
                                                                                                                    String... args)
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with error checking and reads the string response.

Parameters:

command - The command word

args - The command arguments

Returns:

The response string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readInteger

@Command(name="readinteger",
         description="Write command and read integer response")
public int readInteger(@Argument(description="Command word")
                                                                                                                    String command,
                                                                                                                    @Argument(description="Arguments")
                                                                                                                    String... args)
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with error checking and reads the integer response.

Parameters:

command - The command word

args - The command arguments

Returns:

The response string, converted to an integer

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDouble

@Command(name="readdouble",
         description="Write command and read double response")
public double readDouble(@Argument(description="Command wprd")
                                                                                                                    String command,
                                                                                                                    @Argument(description="Arguments")
                                                                                                                    String... args)
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with error checking and reads the double response.

Parameters:

command - The command word

args - The command arguments

Returns:

The response string, converted to a double float

Throws:

org.lsst.ccs.drivers.commons.DriverException

readFloat

@Command(name="readfloat",
         description="Write command and read float response")
public float readFloat(@Argument(description="Command word")
                                                                                                                String command,
                                                                                                                @Argument(description="Arguments")
                                                                                                                String... args)
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with error checking and reads the float response.

Parameters:

command - The command word

args - The command arguments

Returns:

The response string, converted to a float

Throws:

org.lsst.ccs.drivers.commons.DriverException

clear

@Command(name="clear",
         description="Clear saved status")
public void clear()
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Clears saved status.

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

@Command(name="reset",
         description="Reset to power-on state")
public void reset()
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Resets to power-on state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableOpc

@Command(name="enableopc",
         description="Enable operation complete reporting")
public void enableOpc()
                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Enables operation complete reporting.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setEse

@Command(name="setese",
         description="Set event status enable register")
public void setEse(@Argument(description="Value to set")
                                                                                                    int value)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the event status enable register.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSre

@Command(name="setsre",
         description="Set service request enable register")
public void setSre(@Argument(description="Value to set")
                                                                                                       int value)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Sets the service request enable register.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

waitComp

@Command(name="wait",
         description="Wait for previous command completion")
public void waitComp()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Waits for command completion.

Throws:

org.lsst.ccs.drivers.commons.DriverException

showEsr

@Command(name="showesr",
         description="Display the event status register")
public String showEsr()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Displays the event status register.

Returns:

The event status register as a hexadecimal string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showEse

@Command(name="showese",
         description="Display the event status enable register")
public String showEse()
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Displays the event status enable register.

Returns:

The event status enable register as a hexadecimal string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOpc

@Command(name="showopc",
         description="Display the operation complete state")
public int showOpc()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Displays the operation complete state.

Returns:

The operation complete state

Throws:

org.lsst.ccs.drivers.commons.DriverException

showSre

@Command(name="showsre",
         description="Display the service request enable register")
public String showSre()
                                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Displays the service request enable register.

Returns:

The service request enable register as a hexadecimal string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showStatus

@Command(name="showstatus",
         description="Display the status byte")
public String showStatus()
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Displays the status byte.

Returns:

The status byte as a hexadecimal string

Throws:

org.lsst.ccs.drivers.commons.DriverException

selfTest

@Command(name="selftest",
         description="Run the self test")
public int selfTest()
                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Runs the self test.

Returns:

The status of the self test

Throws:

org.lsst.ccs.drivers.commons.DriverException

showError

@Command(name="showerror",
         description="Display the first error item")
public String showError()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Displays the first error item.

Returns:

The first error item as a string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showIdentification

@Command(name="showident",
         description="Show SCPI device identification")
public String showIdentification()
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Displays SCPI device identification.

Returns:

The device information as a string

Throws:

org.lsst.ccs.drivers.commons.DriverException