org.lsst.ccs.drivers.motrona

Class TestIV251

java.lang.Object

org.lsst.ccs.drivers.motrona.TestIV251

public class TestIV251
extends Object

Program to test Motrona IV251 SSI to serial converter

Constructor Summary

Constructors

Constructor and Description
TestIV251() Constructor

Method Summary

Modifier and Type	Method and Description
void	acivateNewSettings() Activate new settings
void	close() Closes connection
String	listSerialFormats() List available serial formats
void	open(String ident) Opens serial connection to MotronaIV251 device with default baud rate and data characteristics.
void	open(String ident, int baudRate, org.lsst.ccs.drivers.motrona.MotronaIV251.SerialFormat format) Opens serial connection to MotronaIV251 device with specified baud rate and data characteristics.
String	readAll() Read all settings and data from Motrona IV251 Loops over all read commands and returns them in a table format.
int	readEncoderError() Read encoder error bit
int	readPosition() Read encoder position.
String	readSerialSettings() Read and decode serial settings of device
void	repeatSetParameter(MotronaIV251.CmndParam param, int value, int reps) Set a parameter multiple times in close succession (PUrpose: to help diagnose intermittent timeouts)
void	saveSettings() Save settings for next power-up
void	setAndActivateParameter(MotronaIV251.CmndParam param, int value) Set and activate parameter value
void	setDataRate(int value) Set serial baud rate (pending activate command)
void	setDebug(boolean mode) Set debug mode on or off
void	setDelay(long delay) Set delay after completing a command to hardware
void	setParameter(MotronaIV251.CmndParam param, int value) Set parameter value (pending activate command)
void	setSerialFormat(org.lsst.ccs.drivers.motrona.MotronaIV251.SerialFormat format) Set serial format (pending activate command)
String	timestamp() Determines current time

Methods inherited from class java.lang.Object

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

Constructor Detail

TestIV251

public TestIV251()

Constructor

Method Detail

timestamp

@Command(name="timestamp",
         description="Prints current time")
public String timestamp()

Determines current time

Returns:

current time as a String

open

@Command(name="open",
         description="Open default connection to device")
public void open(@Argument(name="ident",description="Identification")
                                                                                                 String ident)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Opens serial connection to MotronaIV251 device with default baud rate and data characteristics.

Parameters:

ident - The identification (serial port name)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="ident",description="Identification")
                                                                                         String ident,
                                                                                         @Argument(name="baud",description="baud rate in Hz")
                                                                                         int baudRate,
                                                                                         @Argument(name="format",description="enumerated data characteristics")
                                                                                         org.lsst.ccs.drivers.motrona.MotronaIV251.SerialFormat format)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens serial connection to MotronaIV251 device with specified baud rate and data characteristics.

Parameters:

ident - The identification (serial port name)

baud - rate (Hz)

data - characteristics (enumerated format)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes connection

Throws:

org.lsst.ccs.drivers.commons.DriverException

readAll

@Command(name="readAll",
         description="Read all IV251 settings and data")
public String readAll()

Read all settings and data from Motrona IV251 Loops over all read commands and returns them in a table format. All DriverExceptions are caught; if one occurs, the data field is replaced by the text (String) associated with the exception.

Returns:

String reporting all data read and exceptions.

readSerialSettings

@Command(name="readSerialSettings",
         description="Read and decode settings")
public String readSerialSettings()
                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Read and decode serial settings of device

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPosition

@Command(name="readPosition",
         description="Read encoder position")
public int readPosition()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Read encoder position.

Returns:

encoder position value

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

readEncoderError

@Command(name="readEncoderError",
         description="<1|0> if <encoder error|no encoder error>")
public int readEncoderError()
                                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Read encoder error bit

Returns:

<1|0> if

Throws:

Driver - Exception

org.lsst.ccs.drivers.commons.DriverException

setParameter

@Command(name="setParameter",
         description="Set parameter value (pending activate command)")
public void setParameter(@Argument(name=" enumerated CmndParam")
                                                                                                                              MotronaIV251.CmndParam param,
                                                                                                                              @Argument(name="int value")
                                                                                                                              int value)
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Set parameter value (pending activate command)

Parameters:

Enumerated - parameter name

Value - to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

repeatSetParameter

@Command(name="repeatSetParameter",
         description="Set parameter value multiple times in succession")
public void repeatSetParameter(@Argument(name=" enumerated CmndParam")
                                                                                                                                            MotronaIV251.CmndParam param,
                                                                                                                                            @Argument(name="int value")
                                                                                                                                            int value,
                                                                                                                                            @Argument(name="repetitions")
                                                                                                                                            int reps)
                                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Set a parameter multiple times in close succession (PUrpose: to help diagnose intermittent timeouts)

Parameters:

Enumerated - parameter name

Value - to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

acivateNewSettings

@Command(name="activateNewSettings",
         description="copy settings to registers")
public void acivateNewSettings()
                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Activate new settings

Throws:

org.lsst.ccs.drivers.commons.DriverException

setAndActivateParameter

@Command(name="setAndActivateParameter",
         description="Set and activate parameter value")
public void setAndActivateParameter(@Argument(name=" enumerated CmndParam")
                                                                                                                                      MotronaIV251.CmndParam param,
                                                                                                                                      @Argument(name="int value")
                                                                                                                                      int value)
                                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Set and activate parameter value

Parameters:

Enumerated - parameter name

Value - to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDataRate

@Command(name="setDataRate",
         description="Set baud rate.  Danger: last-resort reset only!")
public void setDataRate(@Argument(name=" 600 to 38400",description="Motrona IV251 baud rate setting")
                                                                                                                             int value)
                                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Set serial baud rate (pending activate command)

Parameters:

Serial - baud rate of device only (600 to 38400, default 9600)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setSerialFormat

@Command(name="setSerialFormat",
         description="Set setiral format.  Danger: last-resort reset only!")
public void setSerialFormat(@Argument(name=" <enumerated format>",description="Motrona IV251 serial format setting")
                                                                                                                                          org.lsst.ccs.drivers.motrona.MotronaIV251.SerialFormat format)
                                                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Set serial format (pending activate command)

Parameters:

IV251 - serial format (enum); use listSerialFormats to see enum's

Throws:

org.lsst.ccs.drivers.commons.DriverException

listSerialFormats

@Command(name="listSerialFormats",
         description="list of enum names")
public String listSerialFormats()

List available serial formats

Returns:

List of formats

saveSettings

@Command(name="saveSettings",
         description="Save settings to EEProm for next power-up")
public void saveSettings()
                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Save settings for next power-up

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

@Command(name="setDebug",
         description="set debug mode <true|false>")
public void setDebug(@Argument(name="<true|false>",description="debug mode")
                                                                                                   boolean mode)

Set debug mode on or off

setDelay

@Command(name="setDelay",
         description="set delay after hardware command")
public void setDelay(@Argument(name="delay",description="in ms")
                                                                                                        long delay)

Set delay after completing a command to hardware

Parameters:

long - delay in ms