org.lsst.ccs.drivers.apcpdu

Class APC7900

java.lang.Object

org.lsst.ccs.drivers.ascii.Session

org.lsst.ccs.drivers.apcpdu.APC7900

All Implemented Interfaces:

APC7900Series

public class APC7900
extends org.lsst.ccs.drivers.ascii.Session
implements APC7900Series

Driver for controlling an APC model 7900 power strip. This also works on the newer 7900B model even though its official command syntax has been changed. But there's a bug: outlet names containing dashes cause command errors.

Author:

Owen Saxton

Nested Class Summary

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

org.lsst.ccs.drivers.ascii.Session.ConnType

Field Summary

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

OPTN_KEEP_ALIVE

Fields inherited from interface org.lsst.ccs.drivers.apcpdu.APC7900Series

DEFAULT_BAUDRATE, LOG_TIMEOUT, RUN_TIMEOUT, STATUS_SPLIT_RE

Constructor Summary

Constructors

Constructor and Description
APC7900() Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection
int	delayedOutletOff(int outlet) Turns outlet power off with delay.
int	delayedOutletOff(String outlet) Turns named outlet power off with delay.
int	delayedOutletOn(int outlet) Turns outlet power on with delay.
int	delayedOutletOn(String outlet) Turns named outlet power on with delay.
int	delayedOutletsOff(int[] outlets) Turns outlets power off with delay.
int	delayedOutletsOff(String[] outlets) Turns named outlets power off with delay.
int	delayedOutletsOn(int[] outlets) Turns outlets power on with delay.
int	delayedOutletsOn(String[] outlets) Turns named outlets power on with delay.
String	getFWVersion() Gets the firmware version
int	getOutletCount() Gets the number of outlets
String	getOutletName(int outlet) Gets the name of an outlet
int	getOutletNumber(String outlet) Gets an outlet number, given its name
Map<String,Integer>	getOutletNumberMap() Gets the map of outlet names to numbers
int	getOutletOffDelay(int outlet) Gets the off delay for an outlet
int	getOutletOffDelay(String outlet) Gets the off delay for a named outlet
Map<String,Integer>	getOutletOffDelayMap() Gets the map of outlet names to off delays
int[]	getOutletOffDelays() Gets the off delay for all outlets
int	getOutletOnDelay(int outlet) Gets the on delay for an outlet
int	getOutletOnDelay(String outlet) Gets the on delay for a named outlet
Map<String,Integer>	getOutletOnDelayMap() Gets the map of outlet names to on delays
int[]	getOutletOnDelays() Gets the on delay for all outlets
Map<String,Boolean>	getOutletOnStateMap() Gets the map of outlet names to on (powered) states
boolean[]	getOutletOnStates() Gets the on (powered) state of all outlets
int	getPhaseCount() Gets the number of phases
String	getProductName() Gets the product name
boolean	isOutletOn(int outlet) Gets the on (powered) state of an outlet
boolean	isOutletOn(String outlet) Gets the on (powered) state of an outlet
void	open(org.lsst.ccs.drivers.ascii.Session.ConnType connType, String ident) Opens a connection.
void	open(org.lsst.ccs.drivers.ascii.Session.ConnType connType, String ident, String username, String password) Opens a connection and logs in.
double[]	readCurrent() Reads input currents, one per phase
double	readPower() Reads input power
double[]	readPowers() Reads input VA and power
double	readVA() Reads input VA
String[]	receiveString(String command) Sends a command and receives a string array
void	setOutletName(int outlet, String name) Sets the name of an outlet
int	setOutletOff(int outlet) Turns outlet power off immediately.
int	setOutletOff(String outlet) Turns named outlet power off immediately.
void	setOutletOffDelay(int delay, int outlet) Sets outlet off delay.
void	setOutletOffDelay(int delay, int[] outlets) Sets outlets off delay.
void	setOutletOffDelay(int delay, String outlet) Sets named outlet off delay.
void	setOutletOffDelay(int delay, String[] outlets) Sets named outlets off delay.
int	setOutletOn(int outlet) Turns outlet power on immediately.
int	setOutletOn(String outlet) Turns named outlet power on immediately.
void	setOutletOnDelay(int delay, int outlet) Sets outlet on delay.
void	setOutletOnDelay(int delay, int[] outlets) Sets outlets on delay.
void	setOutletOnDelay(int delay, String outlet) Sets named outlet on delay.
void	setOutletOnDelay(int delay, String[] outlets) Sets named outlets on delay.
int	setOutletsOff(int[] outlets) Turns outlets power off immediately.
int	setOutletsOff(String[] outlets) Turns named outlets power off immediately.
int	setOutletsOn(int[] outlets) Turns outlets power on immediately.
int	setOutletsOn(String[] outlets) Turns named outlets power on immediately.

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

checkReplyLength, getPrompt, isOpen, open, open, receive, receive, responseError, send, setCharTimeout, setConnTimeout, setDebug, setTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.drivers.apcpdu.APC7900Series

getPrompt, isOpen, receive, setDebug

Constructor Detail

APC7900

public APC7900()

Constructor

Method Detail

open

public void open(org.lsst.ccs.drivers.ascii.Session.ConnType connType,
                 String ident,
                 String username,
                 String password)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection and logs in.

Specified by:

open in interface APC7900Series

Parameters:

connType - The enumerated connection type: TELNET or SERIAL

ident - The host name (TELNET) or port name (SERIAL)

username - The user name

password - The password

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(org.lsst.ccs.drivers.ascii.Session.ConnType connType,
                 String ident)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Specified by:

open in interface APC7900Series

Parameters:

connType - The enumerated connection type: TELNET or SERIAL

ident - The host name (TELNET) or port name (SERIAL)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the connection

Specified by:

close in interface APC7900Series

Overrides:

close in class org.lsst.ccs.drivers.ascii.Session

Throws:

org.lsst.ccs.drivers.commons.DriverException

getProductName

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

Gets the product name

Specified by:

getProductName in interface APC7900Series

Returns:

The product name

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFWVersion

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

Gets the firmware version

Specified by:

getFWVersion in interface APC7900Series

Returns:

The firmware version

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPhaseCount

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

Gets the number of phases

Specified by:

getPhaseCount in interface APC7900Series

Returns:

The number of phases

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletCount

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

Gets the number of outlets

Specified by:

getOutletCount in interface APC7900Series

Returns:

The number of outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletName

public String getOutletName(int outlet)
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the name of an outlet

Specified by:

getOutletName in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletName

public void setOutletName(int outlet,
                          String name)
                   throws org.lsst.ccs.drivers.commons.DriverException

Sets the name of an outlet

Specified by:

setOutletName in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletNumber

public int getOutletNumber(String outlet)
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets an outlet number, given its name

Specified by:

getOutletNumber in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The outlet number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletNumberMap

public Map<String,Integer> getOutletNumberMap()
                                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the map of outlet names to numbers

Specified by:

getOutletNumberMap in interface APC7900Series

Returns:

The outlet number map

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelay

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

Gets the on delay for an outlet

Specified by:

getOutletOnDelay in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelay

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

Gets the off delay for an outlet

Specified by:

getOutletOffDelay in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelay

public int getOutletOnDelay(String outlet)
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the on delay for a named outlet

Specified by:

getOutletOnDelay in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelay

public int getOutletOffDelay(String outlet)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets the off delay for a named outlet

Specified by:

getOutletOffDelay in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelays

public int[] getOutletOnDelays()
                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the on delay for all outlets

Specified by:

getOutletOnDelays in interface APC7900Series

Returns:

An array containing the delays for all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelays

public int[] getOutletOffDelays()
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the off delay for all outlets

Specified by:

getOutletOffDelays in interface APC7900Series

Returns:

An array containing the delays for all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelayMap

public Map<String,Integer> getOutletOnDelayMap()
                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the map of outlet names to on delays

Specified by:

getOutletOnDelayMap in interface APC7900Series

Returns:

The delay map

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelayMap

public Map<String,Integer> getOutletOffDelayMap()
                                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the map of outlet names to off delays

Specified by:

getOutletOffDelayMap in interface APC7900Series

Returns:

The delay map

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOnDelay

public void setOutletOnDelay(int delay,
                             int outlet)
                      throws org.lsst.ccs.drivers.commons.DriverException

Sets outlet on delay.

Specified by:

setOutletOnDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered on (-1 = never)

outlet - The outlet number, starting from 1

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOffDelay

public void setOutletOffDelay(int delay,
                              int outlet)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets outlet off delay.

Specified by:

setOutletOffDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered off (-1 = never)

outlet - The outlet number, starting from 1

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOnDelay

public void setOutletOnDelay(int delay,
                             String outlet)
                      throws org.lsst.ccs.drivers.commons.DriverException

Sets named outlet on delay.

Specified by:

setOutletOnDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered on (-1 = never)

outlet - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOffDelay

public void setOutletOffDelay(int delay,
                              String outlet)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets named outlet off delay.

Specified by:

setOutletOffDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered off (-1 = never)

outlet - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOnDelay

public void setOutletOnDelay(int delay,
                             int[] outlets)
                      throws org.lsst.ccs.drivers.commons.DriverException

Sets outlets on delay.

Specified by:

setOutletOnDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered on (-1 = never)

outlets - The array of outlet numbers

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOffDelay

public void setOutletOffDelay(int delay,
                              int[] outlets)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets outlets off delay.

Specified by:

setOutletOffDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered off (-1 = never)

outlets - The array of outlet numbers

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOnDelay

public void setOutletOnDelay(int delay,
                             String[] outlets)
                      throws org.lsst.ccs.drivers.commons.DriverException

Sets named outlets on delay.

Specified by:

setOutletOnDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered on (-1 = never)

outlets - The array of outlet names

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOffDelay

public void setOutletOffDelay(int delay,
                              String[] outlets)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets named outlets off delay.

Specified by:

setOutletOffDelay in interface APC7900Series

Parameters:

delay - The delay (sec) before the outlet is powered off (-1 = never)

outlets - The array of outlet names

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOutletOn

public boolean isOutletOn(int outlet)
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets the on (powered) state of an outlet

Specified by:

isOutletOn in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

Whether the outlet is powered

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOutletOn

public boolean isOutletOn(String outlet)
                   throws org.lsst.ccs.drivers.commons.DriverException

Gets the on (powered) state of an outlet

Specified by:

isOutletOn in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

Whether the outlet is powered

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnStates

public boolean[] getOutletOnStates()
                            throws org.lsst.ccs.drivers.commons.DriverException

Gets the on (powered) state of all outlets

Specified by:

getOutletOnStates in interface APC7900Series

Returns:

A boolean array containing the on state of all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnStateMap

public Map<String,Boolean> getOutletOnStateMap()
                                        throws org.lsst.ccs.drivers.commons.DriverException

Gets the map of outlet names to on (powered) states

Specified by:

getOutletOnStateMap in interface APC7900Series

Returns:

The on state map

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOn

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

Turns outlet power on immediately.

Specified by:

setOutletOn in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOff

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

Turns outlet power off immediately.

Specified by:

setOutletOff in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOn

public int setOutletOn(String outlet)
                throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlet power on immediately.

Specified by:

setOutletOn in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOff

public int setOutletOff(String outlet)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlet power off immediately.

Specified by:

setOutletOff in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOn

public int setOutletsOn(int[] outlets)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns outlets power on immediately.

Specified by:

setOutletsOn in interface APC7900Series

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOff

public int setOutletsOff(int[] outlets)
                  throws org.lsst.ccs.drivers.commons.DriverException

Turns outlets power off immediately.

Specified by:

setOutletsOff in interface APC7900Series

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOn

public int setOutletsOn(String[] outlets)
                 throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlets power on immediately.

Specified by:

setOutletsOn in interface APC7900Series

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOff

public int setOutletsOff(String[] outlets)
                  throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlets power off immediately.

Specified by:

setOutletsOff in interface APC7900Series

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOn

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

Turns outlet power on with delay.

Specified by:

delayedOutletOn in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOff

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

Turns outlet power off with delay.

Specified by:

delayedOutletOff in interface APC7900Series

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOn

public int delayedOutletOn(String outlet)
                    throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlet power on with delay.

Specified by:

delayedOutletOn in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOff

public int delayedOutletOff(String outlet)
                     throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlet power off with delay.

Specified by:

delayedOutletOff in interface APC7900Series

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOn

public int delayedOutletsOn(int[] outlets)
                     throws org.lsst.ccs.drivers.commons.DriverException

Turns outlets power on with delay.

Specified by:

delayedOutletsOn in interface APC7900Series

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOff

public int delayedOutletsOff(int[] outlets)
                      throws org.lsst.ccs.drivers.commons.DriverException

Turns outlets power off with delay.

Specified by:

delayedOutletsOff in interface APC7900Series

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOn

public int delayedOutletsOn(String[] outlets)
                     throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlets power on with delay.

Specified by:

delayedOutletsOn in interface APC7900Series

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOff

public int delayedOutletsOff(String[] outlets)
                      throws org.lsst.ccs.drivers.commons.DriverException

Turns named outlets power off with delay.

Specified by:

delayedOutletsOff in interface APC7900Series

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

public double[] readCurrent()
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads input currents, one per phase

Specified by:

readCurrent in interface APC7900Series

Returns:

The array of input currents (amps)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVA

public double readVA()
              throws org.lsst.ccs.drivers.commons.DriverException

Reads input VA

Specified by:

readVA in interface APC7900Series

Returns:

The VA (watts)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPower

public double readPower()
                 throws org.lsst.ccs.drivers.commons.DriverException

Reads input power

Specified by:

readPower in interface APC7900Series

Returns:

The power (watts)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPowers

public double[] readPowers()
                    throws org.lsst.ccs.drivers.commons.DriverException

Reads input VA and power

Specified by:

readPowers in interface APC7900Series

Returns:

The array of input power values, VA & power (watts)

Throws:

org.lsst.ccs.drivers.commons.DriverException

receiveString

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

Sends a command and receives a string array

Specified by:

receiveString in interface APC7900Series

Parameters:

command - The command to send

Returns:

The string array

Throws:

org.lsst.ccs.drivers.commons.DriverException