WattsUp (LSST Camera Control Software - WattsUp? Meter Driver 2.2.2 API)

java.lang.Object
- org.lsst.ccs.drivers.wattsup.WattsUp

```
public class WattsUp
extends Object
```
Controls a WattsUp? meter

Author:

Owen Saxton

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WattsUp.Listener
Defines an event listener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WattsUp.Listener` Defines an event listener

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FLD_AMPS` Data field - amps
`static int`	`FLD_AMPS_MAX` Data field - maximum amps during interval
`static int`	`FLD_AMPS_MIN` Data field - minimum amps during interval
`static int`	`FLD_COST` Data field - cost over collection period
`static int`	`FLD_COST_MONTH` Data field - cost per month
`static int`	`FLD_DUTY_CYCLE` Data field - duty cycle (fraction of time over power threshold)
`static int`	`FLD_FREQUENCY` Data field - line frequency
`static int`	`FLD_POWER_CYCLE` Data field - power cycle (number of times power was cycled)
`static int`	`FLD_POWER_FACTOR` Data field - power factor (watts / volt-amps)
`static int`	`FLD_VOLT_AMPS` Data field - volt-amps (product of volts and amps)
`static int`	`FLD_VOLTS` Data field - volts
`static int`	`FLD_VOLTS_MAX` Data field - maximum volts during interval
`static int`	`FLD_VOLTS_MIN` Data field - minimum volts during interval
`static int`	`FLD_WATT_HOURS` Data field - watt-hours over collection period
`static int`	`FLD_WATTS` Data field - watts
`static int`	`FLD_WATTS_MAX` Data field - maximum watts during interval
`static int`	`FLD_WATTS_MIN` Data field - minimum watts during interval
`static int`	`FLD_WH_MONTH` Data field - watt-hours per month
`static int`	`LOG_STA_EXTERNAL` Logging status - external
`static int`	`LOG_STA_INTERNAL` Logging status - active internal
`static int`	`LOG_STA_SUSPENDED` Logging status - suspended (memory full)
`static int`	`MEM_OPT_CONDENSE` Memory-full option - condense (sparsify) the data
`static int`	`MEM_OPT_OVERWRITE` Memory-full option - overwrite oldest data
`static int`	`MEM_OPT_SUSPEND` Memory-full option - suspend logging
`static int`	`N_CAL_FIELDS` Number of calibration fields
`static int`	`N_FIELDS` Number of data fields
`static int`	`N_VER_FIELDS` Number of version fields
`static int`	`VER_FLD_CHECKSUM` Version field - checksum
`static int`	`VER_FLD_FWMAJOR` Version field - major firmware version
`static int`	`VER_FLD_FWMINOR` Version field - minor firmware version
`static int`	`VER_FLD_FWTSTAMP` Version field - firmware time stamp (YYYYMMDDHHMM)
`static int`	`VER_FLD_HW_MINOR` Version field - minor hardware version
`static int`	`VER_FLD_HWMAJOR` Version field - major hardware version
`static int`	`VER_FLD_MEMORY` Version field - memory size
`static int`	`VER_FLD_MODEL` Version field - model

Constructor Summary

Constructors
Constructor and Description

WattsUp()
Constructor

Constructors
Constructor and Description
`WattsUp()` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(WattsUp.Listener listener)` Adds an event listener
`void`	`close()` Closes the connection to the meter
`int[]`	`getCalibrationData()` Gets the calibration data
`int`	`getFullOption()` Gets the memory-full handling option
`String[]`	`getHeaderRecord()` Gets the header record
`int`	`getLoggedData()` Gets all the logged data
`int`	`getLoggedFields()` Gets the bit mask of fields being logged
`int`	`getLoggingInterval()` Gets the logging interval
`int`	`getLoggingState()` Gets the logging state
`int`	`getRecordLimit()` Gets the record count limit
`boolean`	`getUserEuro()` Gets the user-set euro flag
`float`	`getUserRate()` Gets the user-set electricity rate
`int`	`getUserThreshold()` Gets the user-set duty cycle threshold
`String[]`	`getVersionData()` Gets the version information
`void`	`open(int index, String serial)` Opens a connection to the meter
`void`	`open(String node, int index, String serial)` Opens a connection to the meter
`void`	`removeListener()` Removes the event listener
`void`	`resetMemory()` Resets (clears) data memory
`void`	`restart()` Restarts the meter
`void`	`setExternalLogging(int interval)` Sets external logging
`void`	`setFullOption(int option)` Sets the memory-full handling option
`int`	`setInternalLogging(int interval)` Sets internal logging
`int`	`setLoggedFields(int mask)` Sets the fields to be logged
`void`	`setLoggingInterval(int interval)` Sets the logging interval
`void`	`setUserParameters(float rate, int threshold, boolean euro)` Sets the user parameters

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FLD_WATTS
```
public static final int FLD_WATTS
```
    Data field - watts
    
    See Also:
    Constant Field Values
  - FLD_VOLTS
```
public static final int FLD_VOLTS
```
    Data field - volts
    
    See Also:
    Constant Field Values
  - FLD_AMPS
```
public static final int FLD_AMPS
```
    Data field - amps
    
    See Also:
    Constant Field Values
  - FLD_WATT_HOURS
```
public static final int FLD_WATT_HOURS
```
    Data field - watt-hours over collection period
    
    See Also:
    Constant Field Values
  - FLD_COST
```
public static final int FLD_COST
```
    Data field - cost over collection period
    
    See Also:
    Constant Field Values
  - FLD_WH_MONTH
```
public static final int FLD_WH_MONTH
```
    Data field - watt-hours per month
    
    See Also:
    Constant Field Values
  - FLD_COST_MONTH
```
public static final int FLD_COST_MONTH
```
    Data field - cost per month
    
    See Also:
    Constant Field Values
  - FLD_WATTS_MAX
```
public static final int FLD_WATTS_MAX
```
    Data field - maximum watts during interval
    
    See Also:
    Constant Field Values
  - FLD_VOLTS_MAX
```
public static final int FLD_VOLTS_MAX
```
    Data field - maximum volts during interval
    
    See Also:
    Constant Field Values
  - FLD_AMPS_MAX
```
public static final int FLD_AMPS_MAX
```
    Data field - maximum amps during interval
    
    See Also:
    Constant Field Values
  - FLD_WATTS_MIN
```
public static final int FLD_WATTS_MIN
```
    Data field - minimum watts during interval
    
    See Also:
    Constant Field Values
  - FLD_VOLTS_MIN
```
public static final int FLD_VOLTS_MIN
```
    Data field - minimum volts during interval
    
    See Also:
    Constant Field Values
  - FLD_AMPS_MIN
```
public static final int FLD_AMPS_MIN
```
    Data field - minimum amps during interval
    
    See Also:
    Constant Field Values
  - FLD_POWER_FACTOR
```
public static final int FLD_POWER_FACTOR
```
    Data field - power factor (watts / volt-amps)
    
    See Also:
    Constant Field Values
  - FLD_DUTY_CYCLE
```
public static final int FLD_DUTY_CYCLE
```
    Data field - duty cycle (fraction of time over power threshold)
    
    See Also:
    Constant Field Values
  - FLD_POWER_CYCLE
```
public static final int FLD_POWER_CYCLE
```
    Data field - power cycle (number of times power was cycled)
    
    See Also:
    Constant Field Values
  - FLD_FREQUENCY
```
public static final int FLD_FREQUENCY
```
    Data field - line frequency
    
    See Also:
    Constant Field Values
  - FLD_VOLT_AMPS
```
public static final int FLD_VOLT_AMPS
```
    Data field - volt-amps (product of volts and amps)
    
    See Also:
    Constant Field Values
  - N_FIELDS
```
public static final int N_FIELDS
```
    Number of data fields
    
    See Also:
    Constant Field Values
  - N_CAL_FIELDS
```
public static final int N_CAL_FIELDS
```
    Number of calibration fields
    
    See Also:
    Constant Field Values
  - MEM_OPT_SUSPEND
```
public static final int MEM_OPT_SUSPEND
```
    Memory-full option - suspend logging
    
    See Also:
    Constant Field Values
  - MEM_OPT_OVERWRITE
```
public static final int MEM_OPT_OVERWRITE
```
    Memory-full option - overwrite oldest data
    
    See Also:
    Constant Field Values
  - MEM_OPT_CONDENSE
```
public static final int MEM_OPT_CONDENSE
```
    Memory-full option - condense (sparsify) the data
    
    See Also:
    Constant Field Values
  - LOG_STA_SUSPENDED
```
public static final int LOG_STA_SUSPENDED
```
    Logging status - suspended (memory full)
    
    See Also:
    Constant Field Values
  - LOG_STA_INTERNAL
```
public static final int LOG_STA_INTERNAL
```
    Logging status - active internal
    
    See Also:
    Constant Field Values
  - LOG_STA_EXTERNAL
```
public static final int LOG_STA_EXTERNAL
```
    Logging status - external
    
    See Also:
    Constant Field Values
  - VER_FLD_MODEL
```
public static final int VER_FLD_MODEL
```
    Version field - model
    
    See Also:
    Constant Field Values
  - VER_FLD_MEMORY
```
public static final int VER_FLD_MEMORY
```
    Version field - memory size
    
    See Also:
    Constant Field Values
  - VER_FLD_HWMAJOR
```
public static final int VER_FLD_HWMAJOR
```
    Version field - major hardware version
    
    See Also:
    Constant Field Values
  - VER_FLD_HW_MINOR
```
public static final int VER_FLD_HW_MINOR
```
    Version field - minor hardware version
    
    See Also:
    Constant Field Values
  - VER_FLD_FWMAJOR
```
public static final int VER_FLD_FWMAJOR
```
    Version field - major firmware version
    
    See Also:
    Constant Field Values
  - VER_FLD_FWMINOR
```
public static final int VER_FLD_FWMINOR
```
    Version field - minor firmware version
    
    See Also:
    Constant Field Values
  - VER_FLD_FWTSTAMP
```
public static final int VER_FLD_FWTSTAMP
```
    Version field - firmware time stamp (YYYYMMDDHHMM)
    
    See Also:
    Constant Field Values
  - VER_FLD_CHECKSUM
```
public static final int VER_FLD_CHECKSUM
```
    Version field - checksum
    
    See Also:
    Constant Field Values
  - N_VER_FIELDS
```
public static final int N_VER_FIELDS
```
    Number of version fields
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WattsUp
```
public WattsUp()
```
    Constructor
- Method Detail
  - open
```
public void open(int index,
        String serial)
          throws WattsUpException
```
    Opens a connection to the meter
    
    Parameters:
    index - The zero-based index of the Modbus adapter within the list of FTDI devices selected by the serial argument
    serial - A string which, if non-null and non-empty, restricts the list of available devices to those with a serial number containing this string
    
    Throws:
    
    WattsUpException
  - open
```
public void open(String node,
        int index,
        String serial)
          throws WattsUpException
```
    Opens a connection to the meter
    
    Parameters:
    node - The name of the node from which the Modbus is being served, or null for the local node
    index - The zero-based index of the Modbus adapter within the list of FTDI devices selected by the serial argument
    serial - A string which, if non-null and non-empty, restricts the list of available devices to those with a serial number containing this string
    
    Throws:
    
    WattsUpException
  - close
```
public void close()
           throws WattsUpException
```
    Closes the connection to the meter
    
    Throws:
    
    WattsUpException
  - addListener
```
public void addListener(WattsUp.Listener listener)
```
    Adds an event listener
    
    Parameters:
    listener - The event listener object, containing the processData, setPowered and setClosed methods.
  - removeListener
```
public void removeListener()
```
    Removes the event listener
  - getLoggedFields
```
public int getLoggedFields()
                    throws WattsUpException
```
    Gets the bit mask of fields being logged
    
    Returns:
    A bit mask where each set bit represents a field being logged.
    
    Throws:
    
    WattsUpException
  - setLoggedFields
```
public int setLoggedFields(int mask)
                    throws WattsUpException
```
    Sets the fields to be logged
    
    Parameters:
    mask - A bit mask where each set bit represents a field to be logged.
    
    Returns:
    The number of data records that can be logged internally.
    
    Throws:
    
    WattsUpException
  - getCalibrationData
```
public int[] getCalibrationData()
                         throws WattsUpException
```
    Gets the calibration data
    
    Returns:
    A 48-element integer array containing the calibration data.
    
    Throws:
    
    WattsUpException
  - getHeaderRecord
```
public String[] getHeaderRecord()
                         throws WattsUpException
```
    Gets the header record
    
    Returns:
    An 18-element string array containing short names for the defined fields.
    
    Throws:
    
    WattsUpException
  - getLoggedData
```
public int getLoggedData()
                  throws WattsUpException
```
    Gets all the logged data
    All the logged data currently stored in the meter is read out and passed to the data listener's processData method, one record at a time. This may take many seconds, depending on the amount of logged data.
    
    Returns:
    The current logging interval (seconds).
    
    Throws:
    
    WattsUpException
  - setInternalLogging
```
public int setInternalLogging(int interval)
                       throws WattsUpException
```
    Sets internal logging
    Data logging is set to be internal, where each logged data record is stored in the meter's internal memory, for subsequent retrieval via getLoggedData.
    
    Parameters:
    interval - The logging interval to set. This is ignored if the memory-full option is set to 2 (sparsify).
    
    Returns:
    The actual current logging interval.
    
    Throws:
    
    WattsUpException
  - setExternalLogging
```
public void setExternalLogging(int interval)
                        throws WattsUpException
```
    Sets external logging
    Data logging is set to be external, wherein a data record is sent at the end of each logging interval and then passed to the process method of the data listener object.
    
    Parameters:
    interval - The logging interval to set.
    
    Throws:
    
    WattsUpException
  - getRecordLimit
```
public int getRecordLimit()
                   throws WattsUpException
```
    Gets the record count limit
    
    Returns:
    The maximum number of data records than can be stored internally.
    
    Throws:
    
    WattsUpException
  - getFullOption
```
public int getFullOption()
                  throws WattsUpException
```
    Gets the memory-full handling option
    
    Returns:
    The memory-full handling option, encoded as follows: 0 = pause; 1 = wrap; 2 = sparsify.
    
    Throws:
    
    WattsUpException
  - setFullOption
```
public void setFullOption(int option)
                   throws WattsUpException
```
    Sets the memory-full handling option
    
    Parameters:
    option - The memory-full option to set, encoded as follows: 0 = pause; 1 = wrap; 2 = sparsify by deleting every other record and doubling the logging interval.
    
    Throws:
    
    WattsUpException
  - resetMemory
```
public void resetMemory()
                 throws WattsUpException
```
    Resets (clears) data memory
    
    Throws:
    
    WattsUpException
  - getLoggingInterval
```
public int getLoggingInterval()
                       throws WattsUpException
```
    Gets the logging interval
    
    Returns:
    The current logging interval in effect.
    
    Throws:
    
    WattsUpException
  - getLoggingState
```
public int getLoggingState()
                    throws WattsUpException
```
    Gets the logging state
    
    Returns:
    The current logging state, encoded as follows: 0 = paused internal; 1 = active internal; 2 = external.
    
    Throws:
    
    WattsUpException
  - setLoggingInterval
```
public void setLoggingInterval(int interval)
                        throws WattsUpException
```
    Sets the logging interval
    
    Parameters:
    interval - The logging interval to set. This is ignored for internal logging with the memory-full option set to 2 (sparsify).
    
    Throws:
    
    WattsUpException
  - getUserRate
```
public float getUserRate()
                  throws WattsUpException
```
    Gets the user-set electricity rate
    
    Returns:
    The user-set electricity rate in currency units (dollars or euros) per KWH.
    
    Throws:
    
    WattsUpException
  - getUserThreshold
```
public int getUserThreshold()
                     throws WattsUpException
```
    Gets the user-set duty cycle threshold
    
    Returns:
    The user-set power threshold (watts) used for calculating the duty cycle.
    
    Throws:
    
    WattsUpException
  - getUserEuro
```
public boolean getUserEuro()
                    throws WattsUpException
```
    Gets the user-set euro flag
    
    Returns:
    The user-set euro flag, true if the currency is euros and false if dollars.
    
    Throws:
    
    WattsUpException
  - setUserParameters
```
public void setUserParameters(float rate,
                     int threshold,
                     boolean euro)
                       throws WattsUpException
```
    Sets the user parameters
    
    Parameters:
    rate - The electricity rate in currency units (dollars or euros) per KWH.
    threshold - The power threshold (watts) used for calculating the duty cycle.
    euro - The euro flag, true if the currency is euros and false if dollars. This is used to display the correct currency symbol on the meter.
    
    Throws:
    
    WattsUpException
  - getVersionData
```
public String[] getVersionData()
                        throws WattsUpException
```
    Gets the version information
    
    Returns:
    An 8-element string array containing version information.
    
    Throws:
    
    WattsUpException
  - restart
```
public void restart()
             throws WattsUpException
```
    Restarts the meter
    This has the same effect as power cycling the meter.
    
    Throws:
    
    WattsUpException

Class WattsUp

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLD_WATTS

FLD_VOLTS

FLD_AMPS

FLD_WATT_HOURS

FLD_COST

FLD_WH_MONTH

FLD_COST_MONTH

FLD_WATTS_MAX

FLD_VOLTS_MAX

FLD_AMPS_MAX

FLD_WATTS_MIN

FLD_VOLTS_MIN

FLD_AMPS_MIN

FLD_POWER_FACTOR

FLD_DUTY_CYCLE

FLD_POWER_CYCLE

FLD_FREQUENCY

FLD_VOLT_AMPS

N_FIELDS

N_CAL_FIELDS

MEM_OPT_SUSPEND

MEM_OPT_OVERWRITE

MEM_OPT_CONDENSE

LOG_STA_SUSPENDED

LOG_STA_INTERNAL

LOG_STA_EXTERNAL

VER_FLD_MODEL

VER_FLD_MEMORY

VER_FLD_HWMAJOR

VER_FLD_HW_MINOR

VER_FLD_FWMAJOR

VER_FLD_FWMINOR

VER_FLD_FWTSTAMP

VER_FLD_CHECKSUM

N_VER_FIELDS

Constructor Detail

WattsUp

Method Detail

open

open

close

addListener

removeListener

getLoggedFields

setLoggedFields

getCalibrationData

getHeaderRecord

getLoggedData

setInternalLogging

setExternalLogging

getRecordLimit

getFullOption

setFullOption

resetMemory

getLoggingInterval

getLoggingState

setLoggingInterval

getUserRate

getUserThreshold

getUserEuro

setUserParameters

getVersionData

restart