org.lsst.ccs.drivers.auxelex

Class TestSrp

java.lang.Object

org.lsst.ccs.drivers.auxelex.TestSrp

Direct Known Subclasses:

TestBfr, TestHeaterPS, TestIonPump, TestPduCommon, TestRebBulkPS, TestRebPS

public class TestSrp
extends Object

Program to test the SLAC Register Protocol driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TestSrp.ConsThread Inner class for detecting console input while reading continuously.
protected static class	TestSrp.OnOff Data fields

Field Summary

Fields

Modifier and Type	Field and Description
protected TestSrp.ConsThread	consThread
protected Srp	srp

Constructor Summary

Constructors

Constructor and Description
TestSrp() Constructor.
TestSrp(Srp srp) Constructor.

Method Summary

Modifier and Type	Method and Description
void	connect(int node) Connects to a device.
void	connect(int node, int port) Connects to a device.
void	connectIp(String ipAddr) Connects to a device.
void	connectIp(String ipAddr, int port) Connects to a device.
String	contRead(int addr, int count) Continuously reads registers.
void	disconnect() Disconnects from the device.
protected static String	formatHex(int addr, int[] data) Formats, in hexadecimal, array of register values.
protected static String	formatRate(long start, int count) Formats continuous test rates.
String	read(int addr) Reads a register.
String	read(int addr, int count) Reads registers.
void	setDebug(TestSrp.OnOff state) Sets the debug state.
void	setSrpVersion(int version) Sets the SRP version
Srp.BoardType	showBoardType() Shows the board type.
String	showBuildStamp() Shows the build stamp.
void	update(int addr, int mask, int value) Updates a register.
void	write(int addr, int... value) Writes registers.

Methods inherited from class java.lang.Object

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

Field Detail

srp

protected final Srp srp

consThread

protected final TestSrp.ConsThread consThread

Constructor Detail

TestSrp

public TestSrp()

Constructor.

TestSrp

public TestSrp(Srp srp)

Constructor.

Parameters:

srp - Srp object

Method Detail

setSrpVersion

@Command(description="Set the SRP version")
public void setSrpVersion(@Argument(description="Version number")
                                                                      int version)

Sets the SRP version

Parameters:

version - The version to set

setDebug

@Command(description="Set the debug state")
public void setDebug(@Argument(description="The state (on or off)")
                                                                 TestSrp.OnOff state)

Sets the debug state.

Parameters:

state - The debug state to set, ON or OFF

connectIp

@Command(description="Open connection to device")
public void connectIp(@Argument(description="IP address")
                                                                        String ipAddr,
                                                                        @Argument(description="Port number")
                                                                        int port)
                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Connects to a device.

Parameters:

ipAddr - The IP address

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

connectIp

@Command(description="Open connection to device")
public void connectIp(@Argument(description="IP address")
                                                                        String ipAddr)
                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Connects to a device.

Parameters:

ipAddr - The IP address

Throws:

org.lsst.ccs.drivers.commons.DriverException

connect

@Command(description="Open connection to device")
public void connect(@Argument(description="Node number")
                                                                      int node,
                                                                      @Argument(description="Port number")
                                                                      int port)
                                                               throws org.lsst.ccs.drivers.commons.DriverException

Connects to a device.

Parameters:

node - The node number

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

connect

@Command(description="Open connection to device")
public void connect(@Argument(description="Node number")
                                                                      int node)
                                                               throws org.lsst.ccs.drivers.commons.DriverException

Connects to a device.

Parameters:

node - The node number

Throws:

org.lsst.ccs.drivers.commons.DriverException

disconnect

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

Disconnects from the device.

Throws:

org.lsst.ccs.drivers.commons.DriverException

showBoardType

@Command(description="Show the board type")
public Srp.BoardType showBoardType()
                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Shows the board type.

Returns:

The board type

Throws:

org.lsst.ccs.drivers.commons.DriverException

showBuildStamp

@Command(description="Show the build stamp")
public String showBuildStamp()
                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the build stamp.

Returns:

The build stamp

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(description="Read a register")
public String read(@Argument(description="Register address")
                                                           int addr)
                                                    throws org.lsst.ccs.drivers.commons.DriverException

Reads a register.

Parameters:

addr - The register address

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

read

@Command(description="Reads registers")
public String read(@Argument(description="Register address")
                                                           int addr,
                                                           @Argument(description="Register count")
                                                           int count)
                                                    throws org.lsst.ccs.drivers.commons.DriverException

Reads registers.

Parameters:

addr - The first register address

count - The number of registers to read

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

write

@Command(description="Write a register")
public void write(@Argument(description="Register address")
                                                           int addr,
                                                           @Argument(description="Register values")
                                                           int... value)
                                                    throws org.lsst.ccs.drivers.commons.DriverException

Writes registers.

Parameters:

addr - The first register address

value - The values to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

update

@Command(description="Update a register")
public void update(@Argument(description="Register address")
                                                             int addr,
                                                             @Argument(description="Mask of bits to change")
                                                             int mask,
                                                             @Argument(description="Register value")
                                                             int value)
                                                      throws org.lsst.ccs.drivers.commons.DriverException

Updates a register.

Parameters:

addr - The register address

mask - The mask of bits to change

value - The value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

contRead

@Command(description="Continuously read a set of registers")
public String contRead(@Argument(description="First register address")
                                                                                    int addr,
                                                                                    @Argument(description="Number of registers")
                                                                                    int count)
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Continuously reads registers.

Parameters:

addr - The first register address

count - The number of registers to read

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

formatHex

protected static String formatHex(int addr,
                                  int[] data)

Formats, in hexadecimal, array of register values.

Parameters:

addr - The address of the first data word

data - Array of data words

Returns:

The result string

formatRate

protected static String formatRate(long start,
                                   int count)

Formats continuous test rates.

Parameters:

start - The start time

count - The number of operations

Returns:

The result string