org.lsst.ccs.drivers.auxelex

Class PduCommon

java.lang.Object

org.lsst.ccs.drivers.auxelex.Srp

org.lsst.ccs.drivers.auxelex.PduCommon

Direct Known Subclasses:

Pdu5V, PduHV

public class PduCommon
extends Srp

Common routines for controlling the SLAC PDUs

Author:

Owen Saxton

Nested Class Summary

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.auxelex.Srp

Srp.BoardType

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	REG_ADC_BASE Constants and data.
protected static int	REG_ALERTS Constants and data.
protected static int	REG_DEVICE_BASE Constants and data.
protected static int	REG_LINK_FAULT Constants and data.
protected static int	REG_MAIN_STATUS Constants and data.
protected static int	REG_MAIN_SWITCH Constants and data.
protected static int	REG_SWITCHES Constants and data.

Fields inherited from class org.lsst.ccs.drivers.auxelex.Srp

boardType, DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
PduCommon()

Method Summary

Modifier and Type	Method and Description
void	clearAlert(int chan) Clears a channel alert
void	clearAlert(String chan) Clears a named channel alert
void	clearAlerts() Clears all alerts
int	getAlertStatus() Gets the overall alert status
String[]	getChannelNames() Gets the array of channel names
int	getLinkFault() Gets the I2C link fault indicator
int	getMainStatus() Gets the status of the main power
int	getPoweredStatus() Gets the overall powered status
int	getValidChannels() Gets the mask of valid channels
boolean	hasAlert(int chan) Gets the alert state of a channel
boolean	hasAlert(String chan) Gets the alert state of a named channel
boolean	isMainOn() Gets the state of the main power
boolean	isPowered(int chan) Gets the powered state of a channel
boolean	isPowered(String chan) Gets the powered state of a named channel
void	powerOff(int chan) Powers off a channel
void	powerOff(String chan) Powers off a named channel
void	powerOn(int chan) Powers on a channel
void	powerOn(String chan) Powers on a named channel
double	readCurrent(int chan) Reads a channel's current
double	readCurrent(String chan) Reads a named channel's current
double	readVoltage(int chan) Reads a channel's voltage
double	readVoltage(String chan) Reads a named channel's voltage
protected void	setChannelMap(Map chans) Sets the map of channel names
protected void	setCurrentScales(double[] scales) Sets the array of current scale factors
void	setMainOff() Turns off the main power
void	setMainOn() Turns on the main power
protected void	setValidChannels(int chans) Sets the mask of valid channels

Methods inherited from class org.lsst.ccs.drivers.auxelex.Srp

clearSimRegMap, close, getBoardType, getBuildStamp, getIpAddress, getNumSeqErr, getNumTimeout, getSimRegMap, isSimulated, open, open, open, open, putSimRegMap, readReg, readRegs, setDebug, setSrpVersion, setValidBoardTypes, simInitialize, simReadRegs, simWriteRegs, updateReg, writeReg, writeRegs

Methods inherited from class java.lang.Object

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

Field Detail

REG_DEVICE_BASE

protected static final int REG_DEVICE_BASE

Constants and data.

See Also:

Constant Field Values

REG_SWITCHES

protected static final int REG_SWITCHES

Constants and data.

See Also:

Constant Field Values

REG_MAIN_SWITCH

protected static final int REG_MAIN_SWITCH

Constants and data.

See Also:

Constant Field Values

REG_MAIN_STATUS

protected static final int REG_MAIN_STATUS

Constants and data.

See Also:

Constant Field Values

REG_ALERTS

protected static final int REG_ALERTS

Constants and data.

See Also:

Constant Field Values

REG_LINK_FAULT

protected static final int REG_LINK_FAULT

Constants and data.

See Also:

Constant Field Values

REG_ADC_BASE

protected static final int REG_ADC_BASE

Constants and data.

See Also:

Constant Field Values

Constructor Detail

PduCommon

public PduCommon()

Method Detail

setValidChannels

protected void setValidChannels(int chans)

Sets the mask of valid channels

Parameters:

chans - The valid channel mask

getValidChannels

public int getValidChannels()

Gets the mask of valid channels

Returns:

The valid channel mask

setCurrentScales

protected void setCurrentScales(double[] scales)

Sets the array of current scale factors

Parameters:

scales - The array of scales, indexed by channel number

setChannelMap

protected void setChannelMap(Map chans)

Sets the map of channel names

Parameters:

chans - The map of channel names to numbers

getChannelNames

public String[] getChannelNames()

Gets the array of channel names

Returns:

The array of channel names

setMainOn

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

Turns on the main power

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMainOff

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

Turns off the main power

Throws:

org.lsst.ccs.drivers.commons.DriverException

isMainOn

public boolean isMainOn()
                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the state of the main power

Returns:

Whether the main power is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMainStatus

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

Gets the status of the main power

Returns:

The status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

powerOn

public void powerOn(int chan)
             throws org.lsst.ccs.drivers.commons.DriverException

Powers on a channel

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

powerOn

public void powerOn(String chan)
             throws org.lsst.ccs.drivers.commons.DriverException

Powers on a named channel

Parameters:

chan - The channel name

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

powerOff

public void powerOff(int chan)
              throws org.lsst.ccs.drivers.commons.DriverException

Powers off a channel

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

powerOff

public void powerOff(String chan)
              throws org.lsst.ccs.drivers.commons.DriverException

Powers off a named channel

Parameters:

chan - The channel name

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getPoweredStatus

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

Gets the overall powered status

Returns:

The channel switch word

Throws:

org.lsst.ccs.drivers.commons.DriverException

isPowered

public boolean isPowered(int chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the powered state of a channel

Parameters:

chan - The channel number

Returns:

Whether the channel is powered on

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

isPowered

public boolean isPowered(String chan)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the powered state of a named channel

Parameters:

chan - The channel name

Returns:

Whether the channel is powered on

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

getAlertStatus

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

Gets the overall alert status

Returns:

The alert status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

hasAlert

public boolean hasAlert(int chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the alert state of a channel

Parameters:

chan - The channel number

Returns:

Whether the channel has an alert

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

hasAlert

public boolean hasAlert(String chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the alert state of a named channel

Parameters:

chan - The channel name

Returns:

Whether the channel has an alert

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

clearAlert

public void clearAlert(int chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Clears a channel alert

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

clearAlert

public void clearAlert(String chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Clears a named channel alert

Parameters:

chan - The channel name

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

clearAlerts

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

Clears all alerts

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

getLinkFault

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

Gets the I2C link fault indicator

Returns:

The fault word

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

public double readVoltage(int chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a channel's voltage

Parameters:

chan - The channel number

Returns:

The voltage on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

readVoltage

public double readVoltage(String chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a named channel's voltage

Parameters:

chan - The channel name

Returns:

The voltage on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid

readCurrent

public double readCurrent(int chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a channel's current

Parameters:

chan - The channel number

Returns:

The current on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel number is invalid

readCurrent

public double readCurrent(String chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a named channel's current

Parameters:

chan - The channel name

Returns:

The current on that channel

Throws:

org.lsst.ccs.drivers.commons.DriverException - if the channel name is invalid