org.lsst.ccs.subsystem.common.devices.power.distribution

Class APC7900Device

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.common.devices.power.distribution.APC7900Device

All Implemented Interfaces:

org.lsst.ccs.framework.AlertHandler, org.lsst.ccs.framework.ClearAlertHandler, org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, org.lsst.ccs.StateChangeListener

public class APC7900Device
extends org.lsst.ccs.monitor.Device
implements org.lsst.ccs.StateChangeListener, org.lsst.ccs.framework.ClearAlertHandler

APC7900 device class

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.ClearAlertHandler

org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode

Field Summary

Fields

Modifier and Type	Field and Description
protected org.lsst.ccs.services.alert.AlertService	alertService
static int	CHAN_CURRENT
static int	CHAN_POWER
protected Map<String,PduOutlet>	mapOfOutlets
protected int	maxReadFailures
protected String	node
protected int	numberOfOutlets
protected List<String>	outlets
protected org.lsst.ccs.utilities.logging.Logger	sLog Deprecated.
protected org.lsst.ccs.services.AgentStateService	stateService
static int	TYPE_POWER
protected boolean	updateNamesInPDU

Fields inherited from class org.lsst.ccs.monitor.Device

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
APC7900Device()

Method Summary

Modifier and Type	Method and Description
void	build()
org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode	canClearAlert(org.lsst.ccs.bus.data.Alert alert, org.lsst.ccs.bus.states.AlertState alertState)
void	causePDUFailure()
void	causeUnintendedOutletFlipOfState(String name)
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
protected void	close() Closes the connection.
void	disable() Disables the PDU.
void	enable() Enables the PDU.
void	forceOutletOff(String name) Forces an outlet to turn off.
void	forceOutletOn(String name) Forces an outlet to turn on.
List<String>	getOutletNames() Gets the list of outlet names.
Map<String,Boolean>	getOutletOnStateMap() Gets the map of outlet on states.
void	init()
protected void	initDevice() Performs configuration.
protected void	initialize() Initializes the device.
boolean	isOutletOn(String name) Gets whether an outlet is on.
void	outletOff(String name) Turns an outlet off.
void	outletOn(String name) Turns an outlet on.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup()
void	setOutletState(String name, PduOutletState state, boolean force) Change the state of an outlet
void	start()
void	stateChanged(Object changedObj, Enum newState, Enum oldState)

Methods inherited from class org.lsst.ccs.monitor.Device

addChannel, addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, dropChannel, getFullName, getName, getOutputLines, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelNow, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

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.framework.ClearAlertHandler

canClearAlert

Methods inherited from interface org.lsst.ccs.framework.HardwareController

checkStarted, checkStopped

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

postBuild, postInit, postShutdown, postStart, shutdown

Field Detail

TYPE_POWER

public static final int TYPE_POWER

See Also:

Constant Field Values

CHAN_CURRENT

public static final int CHAN_CURRENT

See Also:

Constant Field Values

CHAN_POWER

public static final int CHAN_POWER

See Also:

Constant Field Values

node

@ConfigurationParameter(isFinal=true)
protected String node

numberOfOutlets

@ConfigurationParameter(isFinal=true)
protected int numberOfOutlets

outlets

@ConfigurationParameter(isFinal=true)
protected List<String> outlets

updateNamesInPDU

@ConfigurationParameter(isFinal=true)
protected boolean updateNamesInPDU

maxReadFailures

@ConfigurationParameter
protected int maxReadFailures

mapOfOutlets

protected Map<String,PduOutlet> mapOfOutlets

sLog

@Deprecated
protected final org.lsst.ccs.utilities.logging.Logger sLog

Deprecated.

stateService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.AgentStateService stateService

alertService

@LookupField(strategy=TREE)
protected org.lsst.ccs.services.alert.AlertService alertService

Constructor Detail

APC7900Device

public APC7900Device()

Method Detail

build

public void build()

Specified by:

build in interface org.lsst.ccs.framework.HasLifecycle

init

public void init()

Specified by:

init in interface org.lsst.ccs.framework.HasLifecycle

Overrides:

init in class org.lsst.ccs.monitor.Device

start

public void start()

Specified by:

start in interface org.lsst.ccs.framework.HasLifecycle

canClearAlert

public org.lsst.ccs.framework.ClearAlertHandler.ClearAlertCode canClearAlert(org.lsst.ccs.bus.data.Alert alert,
                                                                             org.lsst.ccs.bus.states.AlertState alertState)

Specified by:

canClearAlert in interface org.lsst.ccs.framework.ClearAlertHandler

initDevice

protected void initDevice()

Performs configuration.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Initializes the device.

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

stateChanged

public void stateChanged(Object changedObj,
                         Enum newState,
                         Enum oldState)

Specified by:

stateChanged in interface org.lsst.ccs.StateChangeListener

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

name - The channel name

hwChan - The hardware channel

type - The channel type string

subtype - The channel subtype string

Returns:

Two-element array containing the encoded type [0] and subtype [1]

Throws:

Exception - If parameters are invalid

readChannel

protected double readChannel(int hwChan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

hwChan - The hardware channel number

type - The encoded channel type

Returns:

The read value

readChannelGroup

protected void readChannelGroup()

Overrides:

readChannelGroup in class org.lsst.ccs.monitor.Device

disable

@Command(name="disable",
         description="Disable the connection to the PDU")
public void disable()

Disables the PDU. Needed to relinquish control to the web or another telnet client

Overrides:

disable in class org.lsst.ccs.monitor.Device

enable

@Command(name="enable",
         description="Enable the connection to the PDU")
public void enable()

Enables the PDU.

Overrides:

enable in class org.lsst.ccs.monitor.Device

getOutletNames

@Command(name="getOutletNames",
         description="Get the list of outlet names")
public List<String> getOutletNames()

Gets the list of outlet names.

Returns:

The list of names

getOutletOnStateMap

@Command(name="getOutletOnStateMap",
         description="Get the map of outlet on states")
public Map<String,Boolean> getOutletOnStateMap()
                                                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Gets the map of outlet on states.

Returns:

The map of outlet names to on states (true or false)

Throws:

org.lsst.ccs.drivers.commons.DriverException

outletOn

@Command(name="outletOn",
         description="Turn outlet on")
public void outletOn(@Argument(name="name",description="Outlet name")
                                                                                      String name)
                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Turns an outlet on.

Parameters:

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

outletOff

@Command(name="outletOff",
         description="Turn outlet off")
public void outletOff(@Argument(name="name",description="Outlet name")
                                                                                         String name)
                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Turns an outlet off.

Parameters:

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

forceOutletOn

@Command(name="forceOutletOn",
         description="Force outlet to turn on")
public void forceOutletOn(@Argument(name="name",description="Outlet name")
                                                                                                         String name)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Forces an outlet to turn on.

Parameters:

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

forceOutletOff

@Command(name="forceOutletOff",
         description="Force outlet to turn off")
public void forceOutletOff(@Argument(name="name",description="Outlet name")
                                                                                                            String name)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Forces an outlet to turn off.

Parameters:

name - The outlet name

Throws:

org.lsst.ccs.drivers.commons.DriverException

causeUnintendedOutletFlipOfState

@Command(name="causeUnintendedOutletFlipOfState",
         description="Cause an unintended state transition which raises an alert.",
         simulation=true)
public void causeUnintendedOutletFlipOfState(@Argument(name="name",description="Outlet name")
                                                                                                                                                                                                             String name)
                                                                                                                                                                                                      throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

causePDUFailure

@Command(name="causePDUFailure",
         description="Cause a PDU failure.",
         simulation=true)
public void causePDUFailure()
                                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOutletOn

@Command(name="isOutletOn",
         description="Get whether outlet is on")
public boolean isOutletOn(@Argument(name="name",description="Outlet name")
                                                                                                       String name)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Gets whether an outlet is on.

Parameters:

name - The outlet name

Returns:

Whether outlet is turned on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutletState

@Command(name="setOutletState",
         description="Set the outlet state to a given OutletState")
public void setOutletState(@Argument(allowedValueProvider="getOutletNames",name="name",description="Outlet name")
                                                                                                                               String name,
                                                                                                                               @Argument(name="state",description="The desired PduOutletState")
                                                                                                                               PduOutletState state,
                                                                                                                               @Argument(name="force",description="true to force the state change",defaultValue="false")
                                                                                                                               boolean force)
                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Change the state of an outlet

Parameters:

name - The outlet name

state - The desired PduOutletState for the outlet.

force - true if the state change is to be forced.

Throws:

org.lsst.ccs.drivers.commons.DriverException