org.lsst.ccs.drivers.apcpdu

Interface APC7900Series

All Known Implementing Classes:

APC7900, APC7900B, APC7900Sim

public interface APC7900Series

Driver for controlling an APC model 7900 power strip

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BAUDRATE Constants.
static int	LOG_TIMEOUT Constants.
static int	RUN_TIMEOUT Constants.
static String	STATUS_SPLIT_RE

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
String	getPrompt() Gets the prompt.
boolean	isOpen() Tests whether the connection is open.
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
default double	readPower() Reads input power
default double[]	readPowers() Reads input VA and power
default double	readVA() Reads input VA
String[]	receive(String command) Sends a command and receives the response.
String[]	receiveString(String command) Sends a command and receives a string array.
void	setDebug(boolean on) Sets the debugging state.
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.

Field Detail

DEFAULT_BAUDRATE

static final int DEFAULT_BAUDRATE

Constants.

See Also:

Constant Field Values

LOG_TIMEOUT

static final int LOG_TIMEOUT

Constants.

See Also:

Constant Field Values

RUN_TIMEOUT

static final int RUN_TIMEOUT

Constants.

See Also:

Constant Field Values

STATUS_SPLIT_RE

static final String STATUS_SPLIT_RE

See Also:

Constant Field Values

Method Detail

open

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.

Parameters:

connType - The enumerated connection type: TELNET, FTDI or SERIAL

ident - The host name (TELNET), USB ID (FTDI) or port name (SERIAL)

username - The user name

password - The password

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Opens a connection.

Parameters:

connType - The enumerated connection type: TELNET, FTDI or SERIAL

ident - The host name (TELNET), USB ID (FTDI) or port name (SERIAL)

Throws:

org.lsst.ccs.drivers.commons.DriverException

close

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

Closes the connection

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOpen

boolean isOpen()

Tests whether the connection is open. Implemented by Session

Returns:

Whether the connection is open

setDebug

void setDebug(boolean on)

Sets the debugging state. Implemented by Session

Parameters:

on - Whether debugging is to be enabled

getPrompt

String getPrompt()

Gets the prompt. Implemented by Session

Returns:

The saved prompt

receive

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

Sends a command and receives the response. This is the raw response from Session

Parameters:

command - The command to send

Returns:

An array of strings each of which is a line of the response. The first element is the echoed command.

Throws:

org.lsst.ccs.drivers.commons.DriverException

receiveString

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

Sends a command and receives a string array. This is the response after processing by APC7900x

Parameters:

command - The command to send

Returns:

The string array

Throws:

org.lsst.ccs.drivers.commons.DriverException

getProductName

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

Gets the product name

Returns:

The product name

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFWVersion

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

Gets the firmware version

Returns:

The firmware version

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPhaseCount

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

Gets the number of phases

Returns:

The number of phases

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletCount

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

Gets the number of outlets

Returns:

The number of outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletName

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

Gets the name of an outlet

Parameters:

outlet - The outlet number, starting from 1

Returns:

The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletName

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

Sets the name of an outlet

Parameters:

outlet - The outlet number, starting from 1

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletNumber

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

Gets an outlet number, given its name

Parameters:

outlet - The outlet name

Returns:

The outlet number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletNumberMap

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

Gets the map of outlet names to numbers

Returns:

The outlet number map

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelay

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

Gets the on delay for an outlet

Parameters:

outlet - The outlet number, starting from 1

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelay

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

Gets the off delay for an outlet

Parameters:

outlet - The outlet number, starting from 1

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelay

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

Gets the on delay for a named outlet

Parameters:

outlet - The outlet name

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelay

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

Gets the off delay for a named outlet

Parameters:

outlet - The outlet name

Returns:

The delay (secs) or -1 for never

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelays

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

Gets the on delay for all outlets

Returns:

An array containing the delays for all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelays

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

Gets the off delay for all outlets

Returns:

An array containing the delays for all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnDelayMap

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

Gets the map of outlet names to on delays

Returns:

The delay map

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOffDelayMap

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

Gets the map of outlet names to off delays

Returns:

The delay map

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOnDelay

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

Sets outlet on delay.

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

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

Sets outlet off delay.

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

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

Sets named outlet on delay.

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

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

Sets named outlet off delay.

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

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

Sets outlets on delay.

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

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

Sets outlets off delay.

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

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

Sets named outlets on delay.

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

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

Sets named outlets off delay.

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

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

Gets the on (powered) state of an outlet

Parameters:

outlet - The outlet number, starting from 1

Returns:

Whether the outlet is powered

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOutletOn

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

Gets the on (powered) state of an outlet

Parameters:

outlet - The outlet name

Returns:

Whether the outlet is powered

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnStates

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

Gets the on (powered) state of all outlets

Returns:

A boolean array containing the on state of all outlets

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutletOnStateMap

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

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

Returns:

The on state map

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOn

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

Turns outlet power on immediately.

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOff

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

Turns outlet power off immediately.

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOn

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

Turns named outlet power on immediately.

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletOff

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

Turns named outlet power off immediately.

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOn

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

Turns outlets power on immediately.

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOff

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

Turns outlets power off immediately.

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOn

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

Turns named outlets power on immediately.

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletsOff

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

Turns named outlets power off immediately.

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOn

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

Turns outlet power on with delay.

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOff

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

Turns outlet power off with delay.

Parameters:

outlet - The outlet number, starting from 1

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOn

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

Turns named outlet power on with delay.

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned on (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletOff

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

Turns named outlet power off with delay.

Parameters:

outlet - The outlet name

Returns:

The number of outlets turned off (1)

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOn

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

Turns outlets power on with delay.

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOff

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

Turns outlets power off with delay.

Parameters:

outlets - An array of outlet numbers

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOn

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

Turns named outlets power on with delay.

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

delayedOutletsOff

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

Turns named outlets power off with delay.

Parameters:

outlets - An array of outlet names

Returns:

The number of outlets turned off

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

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

Reads input currents, one per phase

Returns:

The array of input currents (amps)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVA

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

Reads input VA

Returns:

NaN if method not implemented

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPower

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

Reads input power

Returns:

NaN if method not implemented

Throws:

org.lsst.ccs.drivers.commons.DriverException

readPowers

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

Reads input VA and power

Returns:

Two-element array of NaNs if method not implemented

Throws:

org.lsst.ccs.drivers.commons.DriverException