org.lsst.ccs.drivers.wattsup

Class TestWattsUp

java.lang.Object

org.lsst.ccs.drivers.wattsup.TestWattsUp

All Implemented Interfaces:

WattsUp.Listener

public class TestWattsUp
extends Object
implements WattsUp.Listener

Program to test the WattsUp power meter driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestWattsUp.Currency
static class	TestWattsUp.DataType
static class	TestWattsUp.LogType
static class	TestWattsUp.MemFullAction
static class	TestWattsUp.OnOff

Constructor Summary

Constructors

Constructor and Description
TestWattsUp()

Method Summary

Modifier and Type	Method and Description
void	calShow() Shows calibration data.
void	close() Closes meter connection.
void	dataShow(TestWattsUp.DataType type) Shows data.
void	fldSet(int mask) Sets the mask of logged fields.
void	fldShow() Shows the mask of logged fields.
void	hdrShow() Shows header strings.
void	intSet(int intvl) Sets the logging interval.
void	limShow() Shows the record limit.
void	listen(TestWattsUp.OnOff action) Turns the listener on or off.
void	logSet(TestWattsUp.LogType type, int intvl) Sets the logging type and interval.
void	logShow() Shows the logging interval and state.
void	memSet(TestWattsUp.MemFullAction action) Sets the memory-full action.
void	memShow() Shows the memory-full action.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident) Opens connection to a meter.
void	parmSet(double rate, int thresh) Sets the user parameters.
void	parmSet(double rate, int thresh, TestWattsUp.Currency curr) Sets the user parameters.
void	parmShow() Shows the user parameters.
void	processData(double[] data) Processes logged data.
void	reset() Resets memory.
void	restart() Restarts the meter.
void	setClosed() Handles error-induced port closure
void	setPowered(boolean on) Handles powered state change
void	verShow() Shows the version strings.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestWattsUp

public TestWattsUp()

Method Detail

open

@Command(description="Open connection to meter")
public void open(@Argument(description="Connection type")
                                                                  org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                                                                  @Argument(description="Device identification")
                                                                  String ident)
                                                           throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a meter.

Parameters:

connType - The connecton type: serial or ftdi

ident - The device name (serial) or USB serial no. (ftdi)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes meter connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

listen

@Command(description="Enable or disable the listener")
public void listen(@Argument(description="Action to take")
                                                                          TestWattsUp.OnOff action)

Turns the listener on or off.

Parameters:

action - Action to take: on or off

fldSet

@Command(name="fldset",
         description="Set the mask of logged fields")
public void fldSet(@Argument(name="mask",description="Mask to set")
                                                                                                 int mask)
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Sets the mask of logged fields.

Parameters:

mask - Mask of fields to be logged

Throws:

org.lsst.ccs.drivers.commons.DriverException

fldShow

@Command(name="fldshow",
         description="Show the mask of logged fields")
public void fldShow()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the mask of logged fields.

Throws:

org.lsst.ccs.drivers.commons.DriverException

calShow

@Command(name="calshow",
         description="Show the calibration data")
public void calShow()
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Shows calibration data.

Throws:

org.lsst.ccs.drivers.commons.DriverException

hdrShow

@Command(name="hdrshow",
         description="Show the header strings")
public void hdrShow()
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Shows header strings.

Throws:

org.lsst.ccs.drivers.commons.DriverException

limShow

@Command(name="limshow",
         description="Show the record limit")
public void limShow()
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Shows the record limit.

Throws:

org.lsst.ccs.drivers.commons.DriverException

memSet

@Command(name="memset",
         description="Set the memory-full action")
public void memSet(@Argument(name="action",description="Action to take")
                                                                                              TestWattsUp.MemFullAction action)
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the memory-full action.

Parameters:

action - The memory-full action: suspend, overwrite or condense

Throws:

org.lsst.ccs.drivers.commons.DriverException

memShow

@Command(name="memshow",
         description="Show the memory-full action")
public void memShow()
                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Shows the memory-full action.

Throws:

org.lsst.ccs.drivers.commons.DriverException

intSet

@Command(name="intset",
         description="Set the logging interval")
public void intSet(@Argument(name="intvl",description="Logging interval")
                                                                                            int intvl)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the logging interval.

Parameters:

intvl - The logging interval (secs)

Throws:

org.lsst.ccs.drivers.commons.DriverException

logSet

@Command(name="logset",
         description="Set the logging type and interval")
public void logSet(@Argument(name="type",description="Logging type")
                                                                                                     TestWattsUp.LogType type,
                                                                                                     @Argument(name="intvl",description="Logging Interval")
                                                                                                     int intvl)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Sets the logging type and interval.

Parameters:

type - The logging type: internal or external

intvl - The logging interval (secs)

Throws:

org.lsst.ccs.drivers.commons.DriverException

logShow

@Command(name="logshow",
         description="Show the logging interval & state")
public void logShow()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Shows the logging interval and state.

Throws:

org.lsst.ccs.drivers.commons.DriverException

parmSet

@Command(name="parmset",
         description="Set the user parameters")
public void parmSet(@Argument(name="rate",description="Electricity rate")
                                                                                             double rate,
                                                                                             @Argument(name="thresh",description="Duty cycle threshold")
                                                                                             int thresh,
                                                                                             @Argument(name="curr",description="Currency")
                                                                                             TestWattsUp.Currency curr)
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Sets the user parameters.

Parameters:

rate - The electricity rate: currency units / KWH

thresh - The duty cycle threshold

curr - The currency: dollar or euro

Throws:

org.lsst.ccs.drivers.commons.DriverException

parmSet

@Command(name="parmset",
         description="Set the user parameters")
public void parmSet(@Argument(name="rate",description="Electricity rate")
                                                                                             double rate,
                                                                                             @Argument(name="thresh",description="Duty cycle threshold")
                                                                                             int thresh)
                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Sets the user parameters.

Parameters:

rate - The electricity rate: currency units / KWH

thresh - The duty cycle threshold

Throws:

org.lsst.ccs.drivers.commons.DriverException

parmShow

@Command(name="parmshow",
         description="Show the user parameters")
public void parmShow()
                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the user parameters.

Throws:

org.lsst.ccs.drivers.commons.DriverException

verShow

@Command(name="vershow",
         description="Show the version strings")
public void verShow()
                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Shows the version strings.

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

@Command(name="reset",
         description="Reset memory")
public void reset()
                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Resets memory.

Throws:

org.lsst.ccs.drivers.commons.DriverException

restart

@Command(name="restart",
         description="Restart the meter")
public void restart()
                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Restarts the meter.

Throws:

org.lsst.ccs.drivers.commons.DriverException

dataShow

@Command(name="datashow",
         description="Show data")
public void dataShow(@Argument(name="type",description="Display type")
                                                                                 TestWattsUp.DataType type)
                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Shows data.

Parameters:

type - The type of display: detail or summary

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPowered

public void setPowered(boolean on)

Handles powered state change

Specified by:

setPowered in interface WattsUp.Listener

Parameters:

on - Whether the power is on

setClosed

public void setClosed()

Handles error-induced port closure

Specified by:

setClosed in interface WattsUp.Listener

processData

public void processData(double[] data)

Description copied from interface: WattsUp.Listener

Processes logged data.

Specified by:

processData in interface WattsUp.Listener

Parameters:

data - An 18-element double array containing the data.