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:

PduHV, PduLV

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	ADC_AD_IN_BASE Constants and data.
protected static int	ADC_ALERT Constants and data.
protected static int	ADC_CONTROL Constants and data.
protected static int	ADC_CURR_MEAS Constants and data.
protected static int	ADC_FAULT Constants and data.
protected static int	ADC_FAULT_COR Constants and data.
protected static int	ADC_INCREMENT Constants and data.
protected static int	ADC_MAX_MEAS Constants and data.
protected static int	ADC_MAX_THRESH Constants and data.
protected static int	ADC_MIN_MEAS Constants and data.
protected static int	ADC_MIN_THRESH Constants and data.
protected static int	ADC_POWER_BASE Constants and data.
protected static int	ADC_SENSE_BASE Constants and data.
protected static int	ADC_STATUS Constants and data.
protected static int	ADC_V_IN_BASE Constants and data.
protected static double	CURR_SCALE
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.
protected static double	VOLT_SCALE

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

DEFAULT_PORT

Constructor Summary

Constructors

Constructor and Description
PduCommon()

Method Summary

Modifier and Type	Method and Description
int	getAlertStatus() Gets the status of the alerts
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	getSwitchStatus() Gets the channel power status
int	getValidChannels() Gets the mask of valid channels
boolean	isChannelOn(int chan) Gets the state of a channel's power
boolean	isChannelOn(String chan) Gets the state of a named channel's power
boolean	isMainOn() Gets the state of the main power
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
void	setChannelOff(int chan) Turns off a channel
void	setChannelOff(String chan) Turns off a named channel
void	setChannelOn(int chan) Turns on a channel
void	setChannelOn(String chan) Turns on a named channel
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, getIpAddress, getNumSeqErr, getNumTimeout, getSimRegMap, isSimulated, open, open, putSimRegMap, readReg, readRegs, setDebug, setProbeAddress, 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

ADC_INCREMENT

protected static final int ADC_INCREMENT

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

ADC_CONTROL

protected static final int ADC_CONTROL

Constants and data.

See Also:

Constant Field Values

ADC_ALERT

protected static final int ADC_ALERT

Constants and data.

See Also:

Constant Field Values

ADC_STATUS

protected static final int ADC_STATUS

Constants and data.

See Also:

Constant Field Values

ADC_FAULT

protected static final int ADC_FAULT

Constants and data.

See Also:

Constant Field Values

ADC_FAULT_COR

protected static final int ADC_FAULT_COR

Constants and data.

See Also:

Constant Field Values

ADC_POWER_BASE

protected static final int ADC_POWER_BASE

Constants and data.

See Also:

Constant Field Values

ADC_SENSE_BASE

protected static final int ADC_SENSE_BASE

Constants and data.

See Also:

Constant Field Values

ADC_V_IN_BASE

protected static final int ADC_V_IN_BASE

Constants and data.

See Also:

Constant Field Values

ADC_AD_IN_BASE

protected static final int ADC_AD_IN_BASE

Constants and data.

See Also:

Constant Field Values

ADC_CURR_MEAS

protected static final int ADC_CURR_MEAS

Constants and data.

See Also:

Constant Field Values

ADC_MAX_MEAS

protected static final int ADC_MAX_MEAS

Constants and data.

See Also:

Constant Field Values

ADC_MIN_MEAS

protected static final int ADC_MIN_MEAS

Constants and data.

See Also:

Constant Field Values

ADC_MAX_THRESH

protected static final int ADC_MAX_THRESH

Constants and data.

See Also:

Constant Field Values

ADC_MIN_THRESH

protected static final int ADC_MIN_THRESH

Constants and data.

See Also:

Constant Field Values

VOLT_SCALE

protected static final double VOLT_SCALE

See Also:

Constant Field Values

CURR_SCALE

protected static final double CURR_SCALE

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

setChannelOn

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

Turns on a channel

Parameters:

chan - The channel number

Throws:

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

setChannelOn

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

Turns on a named channel

Parameters:

chan - The channel name

Throws:

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

setChannelOff

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

Turns off a channel

Parameters:

chan - The channel number

Throws:

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

setChannelOff

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

Turns off a named channel

Parameters:

chan - The channel name

Throws:

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

isChannelOn

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

Gets the state of a channel's power

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

isChannelOn

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

Gets the state of a named channel's power

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

getSwitchStatus

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

Gets the channel power status

Returns:

The channel switch word

Throws:

org.lsst.ccs.drivers.commons.DriverException

getAlertStatus

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

Gets the status of the alerts

Returns:

The alert status word

Throws:

org.lsst.ccs.drivers.commons.DriverException

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