org.lsst.ccs.drivers.hameg

Class TestHMP

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.scpi.TestScpi

org.lsst.ccs.drivers.hameg.TestHMP

public class TestHMP
extends org.lsst.ccs.drivers.scpi.TestScpi

Program to test the Hameg HMP Series device driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestHMP.OnOff

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.ascii.TestAscii.ConnType

Field Summary

Fields inherited from class org.lsst.ccs.drivers.scpi.TestScpi

scpi

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

dev

Constructor Summary

Constructors

Constructor and Description
TestHMP() Constructor

Method Summary

Modifier and Type	Method and Description
void	beep() Sounds the beeper.
void	clearVoltTrip() Clears the voltage tripped state.
void	clearVoltTrip(int chan) Clears the voltage tripped state.
void	lock() Locks the front panel.
void	open(org.lsst.ccs.drivers.ascii.TestAscii.ConnType connType, String ident) Opens connection to a device.
void	open(org.lsst.ccs.drivers.ascii.TestAscii.ConnType connType, String ident, int baudRate) Opens connection to a device.
String	readCurrent() Reads the actual current.
String	readCurrent(int chan) Reads the actual current.
String	readVoltage() Reads the actual voltage.
String	readVoltage(int chan) Reads the actual voltage.
void	setChannel(int chan) Sets the channel.
void	setCurrent(double value) Sets the current.
void	setCurrent(double value, int chan) Sets the current.
void	setMaxCurrent() Sets the current to the maximum.
void	setMaxCurrent(int chan) Sets the current to the maximum.
void	setMaxVoltage() Sets the voltage to the maximum.
void	setMaxVoltage(int chan) Sets the voltage to the maximum.
void	setOutput(TestHMP.OnOff state) Turns the output on or off.
void	setOutput(TestHMP.OnOff state, int chan) Turns the output on or off.
void	setVoltage(double value) Sets the voltage.
void	setVoltage(double value, int chan) Sets the voltage.
void	setVoltLimit(double value) Sets the voltage limit.
void	setVoltLimit(double value, int chan) Sets the voltage limit.
String	showChannel() Shows the set channel.
String	showCurrent() Shows the set current.
String	showCurrent(int chan) Shows the set current.
String	showMaxCurrent() Shows the maximum current.
String	showMaxCurrent(int chan) Shows the maximum current.
String	showMaxVoltage() Shows the maximum voltage.
String	showMaxVoltage(int chan) Shows the maximum voltage.
String	showNumChannels() Shows the number of channels.
String	showOutput() Shows the output state.
String	showOutput(int chan) Shows the output state.
String	showVoltage() Shows the set voltage.
String	showVoltage(int chan) Shows the set voltage.
String	showVoltageLimit() Shows the voltage limit.
String	showVoltLimit(int chan) Shows the voltage limit.
String	showVoltTrip() Shows the voltage tripped state.
String	showVoltTrip(int chan) Shows the voltage tripped state.
void	unlock() Unlocks the front panel.

Methods inherited from class org.lsst.ccs.drivers.scpi.TestScpi

clear, enableOpc, readDouble, readFloat, readInteger, readString, reset, selfTest, setEse, setSre, showError, showEse, showEsr, showIdentification, showOpc, showSre, showStatus, waitComp, writeCommand

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

close, open, read, read, setTerm, timeout, write

Methods inherited from class java.lang.Object

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

Constructor Detail

TestHMP

public TestHMP()

Constructor

Method Detail

open

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

Opens connection to a device.

Parameters:

connType - The type of connection: ftdi or serial

ident - The identification: serial no. (ftdi) or port name (serial)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

@Command(name="open",
         description="Open connection to device")
public void open(@Argument(name="type",description="Connection type")
                                                                                         org.lsst.ccs.drivers.ascii.TestAscii.ConnType connType,
                                                                                         @Argument(name="ident",description="Identification")
                                                                                         String ident,
                                                                                         @Argument(name="baud",description="Baud rate")
                                                                                         int baudRate)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device.

Overrides:

open in class org.lsst.ccs.drivers.ascii.TestAscii

Parameters:

connType - The type of connection: ftdi or serial

ident - The identification: serial no. (ftdi) or port name (serial)

baudRate - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

showNumChannels

@Command(name="shownumchannels",
         description="Show the number of channels")
public String showNumChannels()

Shows the number of channels.

Returns:

The result string

setChannel

@Command(name="setchannel",
         description="Set the current channel")
public void setChannel(@Argument(name="channel",description="Channel number")
                                                                                                   int chan)

Sets the channel.

Parameters:

chan - The channel number

showChannel

@Command(name="showchannel",
         description="Show the set channel")
public String showChannel()

Shows the set channel.

Returns:

The result string

setVoltage

@Command(name="setvoltage",
         description="Set the voltage")
public void setVoltage(@Argument(name="value",description="Voltage to set")
                                                                                           double value)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

@Command(name="setvoltage",
         description="Set the voltage")
public void setVoltage(@Argument(name="value",description="Voltage to set")
                                                                                           double value,
                                                                                           @Argument(name="channel",description="Channel number")
                                                                                           int chan)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxVoltage

@Command(name="setmaxvoltage",
         description="Set the voltage to maximum")
public void setMaxVoltage()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage to the maximum.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxVoltage

@Command(name="setmaxvoltage",
         description="Set the voltage to maximum")
public void setMaxVoltage(@Argument(name="channel",description="Channel number")
                                                                                                            int chan)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage to the maximum.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxVoltage

@Command(name="showmaxvoltage",
         description="Show the maximum voltage")
public String showMaxVoltage()
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxVoltage

@Command(name="showmaxvoltage",
         description="Show the maximum voltage")
public String showMaxVoltage(@Argument(name="channel",description="Channel number")
                                                                                                              int chan)
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltage

@Command(name="showvoltage",
         description="Show the set voltage")
public String showVoltage()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltage

@Command(name="showvoltage",
         description="Show the set voltage")
public String showVoltage(@Argument(name="channel",description="Channel number")
                                                                                                    int chan)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

@Command(name="readvoltage",
         description="Read the actual voltage")
public String readVoltage()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

@Command(name="readvoltage",
         description="Read the actual voltage")
public String readVoltage(@Argument(name="channel",description="Channel number")
                                                                                                       int chan)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltLimit

@Command(name="setvoltlimit",
         description="Set the  voltage limit")
public void setVoltLimit(@Argument(name="value",description="Voltage limit to set")
                                                                                                      double value)
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage limit.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltLimit

@Command(name="setvoltlimit",
         description="Set the voltage limit")
public void setVoltLimit(@Argument(name="value",description="Voltage limit to set")
                                                                                                     double value,
                                                                                                     @Argument(name="channel",description="Channel number")
                                                                                                     int chan)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage limit.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltageLimit

@Command(name="showvoltlimit",
         description="Show the voltage limit")
public String showVoltageLimit()
                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Shows the voltage limit.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltLimit

@Command(name="showvoltlimit",
         description="Show the voltage limit")
public String showVoltLimit(@Argument(name="channel",description="Channel number")
                                                                                                          int chan)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the voltage limit.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltTrip

@Command(name="showvolttrip",
         description="Show the voltage tripped state")
public String showVoltTrip()
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the voltage tripped state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltTrip

@Command(name="showvolttrip",
         description="Show the voltage tripped state")
public String showVoltTrip(@Argument(name="channel",description="Channel number")
                                                                                                                int chan)
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the voltage tripped state.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearVoltTrip

@Command(name="clearvolttrip",
         description="Clear the voltage tripped state")
public void clearVoltTrip()
                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Clears the voltage tripped state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearVoltTrip

@Command(name="clearvolttrip",
         description="Clear the voltage tripped state")
public void clearVoltTrip(@Argument(name="channel",description="Channel number")
                                                                                                                 int chan)
                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Clears the voltage tripped state.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

@Command(name="setcurrent",
         description="Set the current")
public void setCurrent(@Argument(name="value",description="Current to set")
                                                                                           double value)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the current.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

@Command(name="setcurrent",
         description="Set the current")
public void setCurrent(@Argument(name="value",description="Current to set")
                                                                                           double value,
                                                                                           @Argument(name="channel",description="Channel number")
                                                                                           int chan)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the current.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxCurrent

@Command(name="setmaxcurrent",
         description="Set the current to maximum")
public void setMaxCurrent()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current to the maximum.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxCurrent

@Command(name="setmaxcurrent",
         description="Set the current to maximum")
public void setMaxCurrent(@Argument(name="channel",description="Channel number")
                                                                                                            int chan)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current to the maximum.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxCurrent

@Command(name="showmaxcurrent",
         description="Show the set current")
public String showMaxCurrent()
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxCurrent

@Command(name="showmaxcurrent",
         description="Show the set current")
public String showMaxCurrent(@Argument(name="channel",description="Channel number")
                                                                                                          int chan)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrent

@Command(name="showcurrent",
         description="Show the set current")
public String showCurrent()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrent

@Command(name="showcurrent",
         description="Show the set current")
public String showCurrent(@Argument(name="channel",description="Channel number")
                                                                                                    int chan)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

@Command(name="readcurrent",
         description="Read the actual current")
public String readCurrent()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

@Command(name="readcurrent",
         description="Read the actual current")
public String readCurrent(@Argument(name="channel",description="Channel number")
                                                                                                       int chan)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setoutput",
         description="Turn output on or off")
public void setOutput(@Argument(name="state",description="Output state: on or off")
                                                                                               TestHMP.OnOff state)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Turns the output on or off.

Parameters:

state - The state to set: on or off

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setoutput",
         description="Turn output on or off")
public void setOutput(@Argument(name="state",description="Output state: on or off")
                                                                                               TestHMP.OnOff state,
                                                                                               @Argument(name="channel",description="Channel number")
                                                                                               int chan)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Turns the output on or off.

Parameters:

state - The state to set: on or off

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

@Command(name="showoutput",
         description="Show the output state")
public String showOutput()
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the output state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

@Command(name="showoutput",
         description="Show the output state")
public String showOutput(@Argument(name="channel",description="Channel number")
                                                                                                   int chan)
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the output state.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

lock

@Command(name="lock",
         description="Lock the front panel")
public void lock()
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Locks the front panel.

Throws:

org.lsst.ccs.drivers.commons.DriverException

unlock

@Command(name="unlock",
         description="Unlock the front panel")
public void unlock()
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Unlocks the front panel.

Throws:

org.lsst.ccs.drivers.commons.DriverException

beep

@Command(name="beep",
         description="Sound the beeper")
public void beep()
                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Sounds the beeper.

Throws:

org.lsst.ccs.drivers.commons.DriverException