org.lsst.ccs.drivers.rebps

Class RebPs

java.lang.Object

org.lsst.ccs.drivers.srp.Srp

org.lsst.ccs.drivers.rebps.RebPs

public class RebPs
extends org.lsst.ccs.drivers.srp.Srp

Routines for controlling a REB power supply

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAN_CURR_AFT_LDO Constants and data.
static int	CHAN_CURR_BEF_LDO Constants and data.
static int	CHAN_VOLT_AFT_LDO Constants and data.
static int	CHAN_VOLT_AFT_SW Constants and data.
static int	CHAN_VOLT_BEF_LDO Constants and data.
static int	CHAN_VOLT_DAC Constants and data.
static int	CHAN_VOLT2_AFT_LDO Constants and data.
static int	EXT_LIMIT_HIGH Constants and data.
static int	EXT_LIMIT_LOW Constants and data.
static int	EXT_VALUE_CURR Constants and data.
static int	EXT_VALUE_MAX Constants and data.
static int	EXT_VALUE_MIN Constants and data.
static int	MAX_REBS Constants and data.
static int	NUM_CHAN_EXT Constants and data.
static int	NUM_EXT_VALUE Constants and data.
static int	NUM_PS Constants and data.
static int	PS_ANALOG Constants and data.
static int	PS_CLK_HIGH Constants and data.
static int	PS_CLK_LOW Constants and data.
static int	PS_DIGITAL Constants and data.
static int	PS_DPHI Constants and data.
static int	PS_HEATER Constants and data.
static int	PS_HV_BIAS Constants and data.
static int	PS_OD Constants and data.
static int	REB_QUANTUM Constants and data.
static int	TYPE_CORNER Constants and data.
static int	TYPE_SCIENCE Constants and data.
static int	TYPE_UNKNOWN Constants and data.
static int	VERSION_PROD Constants and data.
static int	VERSION_PROTO Constants and data.

Constructor Summary

Constructors

Constructor and Description
RebPs()

Method Summary

Modifier and Type	Method and Description
void	configTemperature() Configures the temperature system.
void	configure(int rebNum) Configures all devices of a REB.
void	configure(int rebNum, int psNum) Configures all devices of a power supply.
void	configure(int rebNum, int psNum, int devc) Configures a device.
void	enableAllWrite(boolean on) Sets whether writing of all registers is enabled.
void	enablePowerLeftOn(boolean on) Sets whether leaving power on after failure is enabled.
int	getFailureDetail(int rebNum) Gets the failure details for a REB.
int	getFailureSummary() Gets the failure summary.
int	getFwVersion() Gets the firmware version number.
int	getGeogAddr() Gets the geographical address.
int	getInitStatus() Gets the initialization status.
int	getNumRebs() Gets the number of REBs
int	getNumTemperatures() Gets the number of temperatures
int	getPower(int rebNum) Gets the power options for a REB.
long	getSerialNo() Gets the serial number.
int[]	getTemperatureRes() Gets all temperature resolutions.
int	getTemperatureRes(int sensor) Gets a temperature resolution.
int	getType() Gets the PS type
int	getVersion() Gets the PS firmware version
boolean	isAllWriteEnabled() Gets whether writing of all registers is enabled.
boolean	isPowerLeftOnEnabled() Gets whether leaving power on after failure is enabled.
boolean	isPowerOn(int rebNum) Gets the overall powered state of a REB.
boolean	isPowerOn(int rebNum, int psNum) Gets the powered state of a single REB PS element.
void	open(String ipAddr) Opens a connection to a board.
void	open(String ipAddr, int port) Opens a connection to a board.
double[][]	readChanExtended(int rebNum, int psNum) Reads all extended channel data for a power supply.
double[]	readChanExtended(int rebNum, int psNum, int chan) Reads extended channel data.
double[]	readChannel(int rebNum, int psNum) Reads all channels of a power supply.
double	readChannel(int rebNum, int psNum, int chan) Reads a channel.
double[]	readTemperature() Reads all temperatures.
double	readTemperature(int sensor) Reads a temperature.
double[]	readTempError() Reads all error temperature limits.
double[]	readTempWarn() Reads all warning temperature limits.
void	resetChanExtrema(int rebNum, int psNum, int chan) Resets channel extrema data.
void	setPower(int rebNum, int value) Sets the power options for a REB.
void	setTemperatureRes(int value) Sets the temperature resolution for all sensors.
void	setTemperatureRes(int sensor, int value) Sets the temperature resolution for a sensor.
protected void	simInitialize() Initializes the simulation.
protected void	simWriteRegs(int addr, int[] value, int count) Writes simulated registers.
static boolean	testChannelNumber(int psNum, int chan) Tests a channel number for validity.
static boolean	testPsNumber(int psNum) Tests a power supply number for validity.
boolean	testRebNumber(int rebNum) Tests a REB number for validity.
void	writeDac(int rebNum, int psNum, double value) Writes to a DAC.

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

clearSimRegMap, close, getIpAddress, getNumSeqErr, getNumTimeout, getSimRegMap, isSimulated, putSimRegMap, readReg, readRegs, setDebug, setSrpVersion, simReadRegs, updateReg, writeReg, writeRegs

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_PROTO

public static final int VERSION_PROTO

Constants and data.

See Also:

Constant Field Values

VERSION_PROD

public static final int VERSION_PROD

Constants and data.

See Also:

Constant Field Values

TYPE_UNKNOWN

public static final int TYPE_UNKNOWN

Constants and data.

See Also:

Constant Field Values

TYPE_SCIENCE

public static final int TYPE_SCIENCE

Constants and data.

See Also:

Constant Field Values

TYPE_CORNER

public static final int TYPE_CORNER

Constants and data.

See Also:

Constant Field Values

PS_DIGITAL

public static final int PS_DIGITAL

Constants and data.

See Also:

Constant Field Values

PS_ANALOG

public static final int PS_ANALOG

Constants and data.

See Also:

Constant Field Values

PS_OD

public static final int PS_OD

Constants and data.

See Also:

Constant Field Values

PS_CLK_HIGH

public static final int PS_CLK_HIGH

Constants and data.

See Also:

Constant Field Values

PS_CLK_LOW

public static final int PS_CLK_LOW

Constants and data.

See Also:

Constant Field Values

PS_HEATER

public static final int PS_HEATER

Constants and data.

See Also:

Constant Field Values

PS_DPHI

public static final int PS_DPHI

Constants and data.

See Also:

Constant Field Values

PS_HV_BIAS

public static final int PS_HV_BIAS

Constants and data.

See Also:

Constant Field Values

NUM_PS

public static final int NUM_PS

Constants and data.

See Also:

Constant Field Values

CHAN_VOLT_BEF_LDO

public static final int CHAN_VOLT_BEF_LDO

Constants and data.

See Also:

Constant Field Values

CHAN_CURR_BEF_LDO

public static final int CHAN_CURR_BEF_LDO

Constants and data.

See Also:

Constant Field Values

CHAN_VOLT_AFT_LDO

public static final int CHAN_VOLT_AFT_LDO

Constants and data.

See Also:

Constant Field Values

CHAN_CURR_AFT_LDO

public static final int CHAN_CURR_AFT_LDO

Constants and data.

See Also:

Constant Field Values

CHAN_VOLT_AFT_SW

public static final int CHAN_VOLT_AFT_SW

Constants and data.

See Also:

Constant Field Values

CHAN_VOLT2_AFT_LDO

public static final int CHAN_VOLT2_AFT_LDO

Constants and data.

See Also:

Constant Field Values

CHAN_VOLT_DAC

public static final int CHAN_VOLT_DAC

Constants and data.

See Also:

Constant Field Values

NUM_CHAN_EXT

public static final int NUM_CHAN_EXT

Constants and data.

See Also:

Constant Field Values

EXT_VALUE_CURR

public static final int EXT_VALUE_CURR

Constants and data.

See Also:

Constant Field Values

EXT_VALUE_MAX

public static final int EXT_VALUE_MAX

Constants and data.

See Also:

Constant Field Values

EXT_VALUE_MIN

public static final int EXT_VALUE_MIN

Constants and data.

See Also:

Constant Field Values

EXT_LIMIT_HIGH

public static final int EXT_LIMIT_HIGH

Constants and data.

See Also:

Constant Field Values

EXT_LIMIT_LOW

public static final int EXT_LIMIT_LOW

Constants and data.

See Also:

Constant Field Values

NUM_EXT_VALUE

public static final int NUM_EXT_VALUE

Constants and data.

See Also:

Constant Field Values

REB_QUANTUM

public static final int REB_QUANTUM

Constants and data.

See Also:

Constant Field Values

MAX_REBS

public static final int MAX_REBS

Constants and data.

See Also:

Constant Field Values

Constructor Detail

RebPs

public RebPs()

Method Detail

open

public void open(String ipAddr)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board.

Parameters:

ipAddr - The IP address, or null or empty for simulation

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open(String ipAddr,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection to a board. There are three different kinds of board to be handled, distinguished by the last digit of their IP address: 20 or 21: Prototype with original firmware (3 REBs) 22: Prototype with new firmware (sequencing, new network protocol) Any other value: Production (with new firmware, 6 REBs)

Overrides:

open in class org.lsst.ccs.drivers.srp.Srp

Parameters:

ipAddr - The IP address, or null or empty for simulation

port - The port number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVersion

public int getVersion()

Gets the PS firmware version

Returns:

The PS firmware version (prototype or production)

getNumRebs

public int getNumRebs()

Gets the number of REBs

Returns:

The number of REBs (3: prototype board, 6: production board)

getNumTemperatures

public int getNumTemperatures()

Gets the number of temperatures

Returns:

The number of temperatures (1: prototype board, 7: production board)

getType

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

Gets the PS type

Returns:

The type (unknown, science, corner)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFwVersion

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

Gets the firmware version number.

Returns:

The version number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSerialNo

public long getSerialNo()
                 throws org.lsst.ccs.drivers.commons.DriverException

Gets the serial number.

Returns:

The serial number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getGeogAddr

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

Gets the geographical address.

Returns:

The geographical address

Throws:

org.lsst.ccs.drivers.commons.DriverException

getInitStatus

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

Gets the initialization status.

Returns:

The initialization status

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFailureSummary

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

Gets the failure summary.

Returns:

The failure summary

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFailureDetail

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

Gets the failure details for a REB.

Parameters:

rebNum - The REB number

Returns:

The failure detail

Throws:

org.lsst.ccs.drivers.commons.DriverException

configTemperature

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

Configures the temperature system.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperatureRes

public void setTemperatureRes(int sensor,
                              int value)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the temperature resolution for a sensor. This works only if register writing has been enabled

Parameters:

sensor - The sensor number (0 - 6)

value - The resolution value (0 - 3)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTemperatureRes

public void setTemperatureRes(int value)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the temperature resolution for all sensors. This works only if register writing has been enabled

Parameters:

value - The resolution value (0 - 3)

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTemperatureRes

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

Gets a temperature resolution.

Parameters:

sensor - The sensor number (0 - 6)

Returns:

The resolution (0 - 3), or -1 if hardware error

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTemperatureRes

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

Gets all temperature resolutions.

Returns:

An array of resolutions, in sensor order

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTemperature

public double readTemperature(int sensor)
                       throws org.lsst.ccs.drivers.commons.DriverException

Reads a temperature.

Parameters:

sensor - The sensor number (0 - 6)

Returns:

The temperature (C), or NaN if hardware error occurred

Throws:

org.lsst.ccs.drivers.commons.DriverException - if communications error

readTemperature

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

Reads all temperatures.

Returns:

An array of read temperatures (C) in sensor order

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTempWarn

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

Reads all warning temperature limits.

Returns:

An array of read temperatures (C) in sensor order

Throws:

org.lsst.ccs.drivers.commons.DriverException

readTempError

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

Reads all error temperature limits.

Returns:

An array of read temperatures (C) in sensor order

Throws:

org.lsst.ccs.drivers.commons.DriverException

setPower

public void setPower(int rebNum,
                     int value)
              throws org.lsst.ccs.drivers.commons.DriverException

Sets the power options for a REB.

Parameters:

rebNum - The REB number

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPower

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

Gets the power options for a REB.

Parameters:

rebNum - The REB number

Returns:

The bit mask of power options

Throws:

org.lsst.ccs.drivers.commons.DriverException

isPowerOn

public boolean isPowerOn(int rebNum)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the overall powered state of a REB.

Parameters:

rebNum - The REB number

Returns:

The power state

Throws:

org.lsst.ccs.drivers.commons.DriverException

isPowerOn

public boolean isPowerOn(int rebNum,
                         int psNum)
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the powered state of a single REB PS element.

Parameters:

rebNum - The REB number

psNum - The power supply number

Returns:

The power state

Throws:

org.lsst.ccs.drivers.commons.DriverException

configure

public void configure(int rebNum,
                      int psNum,
                      int devc)
               throws org.lsst.ccs.drivers.commons.DriverException

Configures a device.

Parameters:

rebNum - The REB number

psNum - The power supply number

devc - The device number

Throws:

org.lsst.ccs.drivers.commons.DriverException

configure

public void configure(int rebNum,
                      int psNum)
               throws org.lsst.ccs.drivers.commons.DriverException

Configures all devices of a power supply.

Parameters:

rebNum - The REB number

psNum - The power supply number

Throws:

org.lsst.ccs.drivers.commons.DriverException

configure

public void configure(int rebNum)
               throws org.lsst.ccs.drivers.commons.DriverException

Configures all devices of a REB.

Parameters:

rebNum - The REB number

Throws:

org.lsst.ccs.drivers.commons.DriverException

readChannel

public double readChannel(int rebNum,
                          int psNum,
                          int chan)
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads a channel.

Parameters:

rebNum - The REB number

psNum - The power supply number

chan - The channel number

Returns:

The value of the channel data

Throws:

org.lsst.ccs.drivers.commons.DriverException

readChannel

public double[] readChannel(int rebNum,
                            int psNum)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads all channels of a power supply.

Parameters:

rebNum - The REB number

psNum - The power supply number

Returns:

The array of power supply values

Throws:

org.lsst.ccs.drivers.commons.DriverException

readChanExtended

public double[] readChanExtended(int rebNum,
                                 int psNum,
                                 int chan)
                          throws org.lsst.ccs.drivers.commons.DriverException

Reads extended channel data.

Parameters:

rebNum - The REB number

psNum - The power supply number

chan - The channel number

Returns:

The array of extended channel data

Throws:

org.lsst.ccs.drivers.commons.DriverException

readChanExtended

public double[][] readChanExtended(int rebNum,
                                   int psNum)
                            throws org.lsst.ccs.drivers.commons.DriverException

Reads all extended channel data for a power supply.

Parameters:

rebNum - The REB number

psNum - The power supply number

Returns:

The array of extended channel data

Throws:

org.lsst.ccs.drivers.commons.DriverException

resetChanExtrema

public void resetChanExtrema(int rebNum,
                             int psNum,
                             int chan)
                      throws org.lsst.ccs.drivers.commons.DriverException

Resets channel extrema data.

Parameters:

rebNum - The REB number

psNum - The power supply number

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeDac

public void writeDac(int rebNum,
                     int psNum,
                     double value)
              throws org.lsst.ccs.drivers.commons.DriverException

Writes to a DAC.

Parameters:

rebNum - The REB number

psNum - The power supply number

value - The voltage value to write

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableAllWrite

public void enableAllWrite(boolean on)
                    throws org.lsst.ccs.drivers.commons.DriverException

Sets whether writing of all registers is enabled.

Parameters:

on - True to enable writing; false to disable it

Throws:

org.lsst.ccs.drivers.commons.DriverException

isAllWriteEnabled

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

Gets whether writing of all registers is enabled.

Returns:

Whether writing is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

enablePowerLeftOn

public void enablePowerLeftOn(boolean on)
                       throws org.lsst.ccs.drivers.commons.DriverException

Sets whether leaving power on after failure is enabled.

Parameters:

on - True to enable power left on; false to disable it

Throws:

org.lsst.ccs.drivers.commons.DriverException

isPowerLeftOnEnabled

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

Gets whether leaving power on after failure is enabled.

Returns:

Whether leaving power on is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

testChannelNumber

public static boolean testChannelNumber(int psNum,
                                        int chan)
                                 throws org.lsst.ccs.drivers.commons.DriverException

Tests a channel number for validity.

Parameters:

psNum - The power supply number

chan - The channel number

Returns:

Whether the channel number is valid

Throws:

org.lsst.ccs.drivers.commons.DriverException

testPsNumber

public static boolean testPsNumber(int psNum)

Tests a power supply number for validity.

Parameters:

psNum - The power supply number

Returns:

Whether the power supply number is valid

testRebNumber

public boolean testRebNumber(int rebNum)
                      throws org.lsst.ccs.drivers.commons.DriverException

Tests a REB number for validity.

Parameters:

rebNum - The REB number

Returns:

Whether the REB number is valid

Throws:

org.lsst.ccs.drivers.commons.DriverException

simInitialize

protected void simInitialize()

Initializes the simulation.

Overrides:

simInitialize in class org.lsst.ccs.drivers.srp.Srp

simWriteRegs

protected void simWriteRegs(int addr,
                            int[] value,
                            int count)

Writes simulated registers.

Overrides:

simWriteRegs in class org.lsst.ccs.drivers.srp.Srp

Parameters:

addr - The first register address

value - The array of values to write.

count - The number of values to write.