org.lsst.ccs.drivers.scpi

Class Scpi

java.lang.Object

org.lsst.ccs.drivers.scpi.Scpi

public class Scpi
extends Object

General access routines for a SCPI device.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECK_CONTAINS Identification check type - contains string
static int	CHECK_ENDS_WITH Identification check type - ends with string
static int	CHECK_EQUALS Identification check type - equals string
static int	CHECK_MATCHES Identification check type - matches regular expression
static int	CHECK_STARTS_WITH Identification check type - starts with string
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
static int	IDENT_FW_VERSION Identification field index - firmware version
static int	IDENT_MANUFACTURER Identification field index - manufacturer
static int	IDENT_MODEL_NAME Identification field index - model name
static int	IDENT_SERIAL_NUMBER Identification field index - serial number
static int	SB_ERROR_QUEUE Status byte bit mask - error queue not empty
static int	SB_EVENT_STATUS Status byte bit mask - event status byte summary
static int	SB_MASTER_STATUS Status byte bit mask - master status summary
static int	SB_MESSAGE_AVAILABLE Status byte bit mask - message available
static int	SB_OPERATION_STATUS Status byte bit mask - operation status summary
static int	SB_QUESTIONABLE_STATUS Status byte bit mask - questionable status summary

Constructor Summary

Constructors

Constructor and Description
Scpi()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkIdentification(String manufact, int manCheck, String model, int modCheck) Checks the identification.
void	clearStatus() Clears all status reporting structures.
void	close() Closes the device connection.
boolean	closeSilent() Closes the device connection silently.
void	enableOperationComplete() Enables operation complete reporting.
String	getError() Gets the first item from the error queue.
int	getEventStatus() Gets the event status register value.
int	getEventStatusEnable() Gets the event status enable register value.
String[]	getIdentification() Gets the device identification strings.
int	getOperationComplete() Gets the operation complete state.
int	getServiceRequestEnable() Gets the service request enable register value.
int	getStatusByte() Gets the status byte value.
String	makeChannelList(int chan) Makes a channel list string from a channel number.
String	makeChannelList(int[] chan) Makes a channel list string from an array of channels.
void	open(int type, String ident, int parm) Opens a connection to the device.
String	read() Reads a response.
String	read(String command) Reads a response after writing a command.
double	readDouble(String command) Reads a double with SCPI error checking after writing a command.
double[]	readDoubleArray(String command) Reads a double array with SCPI error checking after writing a command.
float	readFloat(String command) Reads a float with SCPI error checking after writing a command.
float[]	readFloatArray(String command) Reads a float array with SCPI error checking after writing a command.
int	readInteger(String command) Reads an integer with SCPI error checking after writing a command.
int[]	readIntegerArray(String command) Reads an integer array with SCPI error checking after writing a command.
String	readString(String command) Reads a string with SCPI error checking after writing a command.
String[]	readStringArray(String command) Reads a string array with SCPI error checking after writing a command.
void	reset() Resets to power-on state.
int	runSelfTest() Executes internal self-test.
void	setEventStatusEnable(int value) Sets the event status enable register.
void	setServiceRequestEnable(int value) Sets the service request enable register.
void	setTerminator(String term) Sets the command terminator.
void	setTimeout(double time) Sets the read timeout.
boolean	testIdentification(String manufact, int manCheck, String model, int modCheck) Tests the identification.
void	waitCompletion() Waits for previous command completion.
void	write(String command) Writes a command.
void	writeCommand(String command) Writes a command with SCPI error checking.

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

IDENT_MANUFACTURER

public static final int IDENT_MANUFACTURER

Identification field index - manufacturer

See Also:

Constant Field Values

IDENT_MODEL_NAME

public static final int IDENT_MODEL_NAME

Identification field index - model name

See Also:

Constant Field Values

IDENT_SERIAL_NUMBER

public static final int IDENT_SERIAL_NUMBER

Identification field index - serial number

See Also:

Constant Field Values

IDENT_FW_VERSION

public static final int IDENT_FW_VERSION

Identification field index - firmware version

See Also:

Constant Field Values

CHECK_EQUALS

public static final int CHECK_EQUALS

Identification check type - equals string

See Also:

Constant Field Values

CHECK_STARTS_WITH

public static final int CHECK_STARTS_WITH

Identification check type - starts with string

See Also:

Constant Field Values

CHECK_ENDS_WITH

public static final int CHECK_ENDS_WITH

Identification check type - ends with string

See Also:

Constant Field Values

CHECK_CONTAINS

public static final int CHECK_CONTAINS

Identification check type - contains string

See Also:

Constant Field Values

CHECK_MATCHES

public static final int CHECK_MATCHES

Identification check type - matches regular expression

See Also:

Constant Field Values

SB_ERROR_QUEUE

public static final int SB_ERROR_QUEUE

Status byte bit mask - error queue not empty

See Also:

Constant Field Values

SB_QUESTIONABLE_STATUS

public static final int SB_QUESTIONABLE_STATUS

Status byte bit mask - questionable status summary

See Also:

Constant Field Values

SB_MESSAGE_AVAILABLE

public static final int SB_MESSAGE_AVAILABLE

Status byte bit mask - message available

See Also:

Constant Field Values

SB_EVENT_STATUS

public static final int SB_EVENT_STATUS

Status byte bit mask - event status byte summary

See Also:

Constant Field Values

SB_MASTER_STATUS

public static final int SB_MASTER_STATUS

Status byte bit mask - master status summary

See Also:

Constant Field Values

SB_OPERATION_STATUS

public static final int SB_OPERATION_STATUS

Status byte bit mask - operation status summary

See Also:

Constant Field Values

Constructor Detail

Scpi

public Scpi()

Method Detail

open

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

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

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

writeCommand

public void writeCommand(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with SCPI error checking.

Parameters:

command - The command to write, excluding terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException

readString

public String readString(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads a string with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned string value

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readStringArray

public String[] readStringArray(String command)
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads a string array with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned array of string values

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readInteger

public int readInteger(String command)
                throws org.lsst.ccs.drivers.commons.DriverException

Reads an integer with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned integer value

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readIntegerArray

public int[] readIntegerArray(String command)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads an integer array with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned array of integer values

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readDouble

public double readDouble(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads a double with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned double float value

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readDoubleArray

public double[] readDoubleArray(String command)
                         throws org.lsst.ccs.drivers.commons.DriverException

Reads a double array with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned array of double float values

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readFloat

public float readFloat(String command)
                throws org.lsst.ccs.drivers.commons.DriverException

Reads a float with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned float value

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

readFloatArray

public float[] readFloatArray(String command)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads a float array with SCPI error checking after writing a command.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned array of float float values

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

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:

timeout - The read timeout (sec). 0 means no timeout.

Throws:

org.lsst.ccs.drivers.commons.DriverException

testIdentification

public boolean testIdentification(String manufact,
                         int manCheck,
                         String model,
                         int modCheck)
                           throws org.lsst.ccs.drivers.commons.DriverException

Tests the identification.

Parameters:

manufact - The manufacturer to check for, or null if not checking.

manCheck - The type of check to make for the manufacturer.

model - The model to check for, or null if not checking.

modCheck - The type of check to make for the model.

Returns:

Whether or not the identification matches

Throws:

org.lsst.ccs.drivers.commons.DriverException

checkIdentification

public void checkIdentification(String manufact,
                       int manCheck,
                       String model,
                       int modCheck)
                         throws org.lsst.ccs.drivers.commons.DriverException

Checks the identification.

Parameters:

manufact - The manufacturer to check for, or null if not checking.

manCheck - The type of check to make for the manufacturer.

model - The model to check for, or null if not checking.

modCheck - The type of check to make for the model.

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearStatus

public void clearStatus()
                 throws org.lsst.ccs.drivers.commons.DriverException

Clears all status reporting structures.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setEventStatusEnable

public void setEventStatusEnable(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

getEventStatusEnable

public int getEventStatusEnable()
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the event status enable register value.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

getEventStatus

public int getEventStatus()
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets the event status register value.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

getIdentification

public String[] getIdentification()
                           throws org.lsst.ccs.drivers.commons.DriverException

Gets the device identification strings.

Returns:

A four-element array containing, in order: Manufacturer; Model name; Serial number; Firmware version.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

enableOperationComplete

public void enableOperationComplete()
                             throws org.lsst.ccs.drivers.commons.DriverException

Enables operation complete reporting.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOperationComplete

public int getOperationComplete()
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the operation complete state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

reset

public void reset()
           throws org.lsst.ccs.drivers.commons.DriverException

Resets to power-on state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setServiceRequestEnable

public void setServiceRequestEnable(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

getServiceRequestEnable

public int getServiceRequestEnable()
                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the service request enable register value.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

getStatusByte

public int getStatusByte()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the status byte value.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

runSelfTest

public int runSelfTest()
                throws org.lsst.ccs.drivers.commons.DriverException

Executes internal self-test.

Throws:

org.lsst.ccs.drivers.commons.DriverException

org.lsst.ccs.drivers.commons.DriverTimeoutException

waitCompletion

public void waitCompletion()
                    throws org.lsst.ccs.drivers.commons.DriverException

Waits for previous command completion.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getError

public String getError()
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the first item from the error queue.

Returns:

The error queue item

Throws:

org.lsst.ccs.drivers.commons.DriverException

makeChannelList

public String makeChannelList(int chan)

Makes a channel list string from a channel number.

Parameters:

chan - The channel number

Returns:

The created channel list

makeChannelList

public String makeChannelList(int[] chan)

Makes a channel list string from an array of channels.

Parameters:

chan - The array of channel numbers

Returns:

The created channel list