org.lsst.ccs.subsystem.refrig

Class PowerDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.refrig.PowerDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle

Direct Known Subclasses:

BK1696Device, BK9130Device, BKXLNDevice, DcsDevice, HeaterPsDevice, SimDevice.Power, SimPowerDevice

public class PowerDevice
extends org.lsst.ccs.monitor.Device
implements org.lsst.ccs.framework.HasLifecycle

Defines a power supply interface.

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PowerDevice.ChannelState Inner class for saving the power state of a channel.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.lsst.ccs.drivers.commons.DriverConstants.ConnType	connType
protected String	devcId
protected int	devcParm
protected double[]	maxCurrent
protected double	minVoltage
protected static int	MON_TYPE_CURRENT
protected static int	MON_TYPE_POWER
protected static int	MON_TYPE_VOLTAGE
protected static Map<String,Integer>	mTypeMap
protected static int	NETWORK_CONN_INVALID
protected org.lsst.ccs.drivers.commons.PowerSupplyDriver	psd
protected int	settlingTime
protected double	softMaxCurrent

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

alertOfflineId, alertService, configService, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, path, s

Constructor Summary

Constructors

Constructor and Description
PowerDevice(String name, org.lsst.ccs.drivers.commons.PowerSupplyDriver psd, int options, int minChan, int maxChan) Constructor.

Method Summary

Modifier and Type	Method and Description
void	build() Build phase
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	enableOutput(int chan, boolean enable) Enables the output.
org.lsst.ccs.drivers.commons.DriverConstants.ConnType	getConnType() Gets the connection type.
String	getDevcId() Gets the device ID.
int	getDevcParm() Gets the device parameter.
int	getMaxChannel() Gets the maximum channel number.
int	getMinChannel() Gets the minimum channel number.
boolean	getOutput(int chan) Gets the output state.
double	getPower(int chan) Gets the power for a channel.
boolean	hasNoLoad(int chan) Gets whether a "no load" error occurred.
boolean	hasVoltError(int chan) Gets whether a voltage setting error occurred.
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
boolean	isEnabled(int chan) Gets the enabled state.
protected void	maintainPower() Maintains the power for all channels at their set value.
protected double	readChannel(int hwChan, int type) Reads a channel.
protected void	readChannelGroup() Initializes voltages and currents as unread.
double	readCurrent(int chan) Reads the current.
double	readVoltage(int chan) Reads the voltage.
void	setCurrent(int chan, double value) Sets the current.
protected void	setOnline(boolean online) Sets the online state.
void	setOutput(int chan, boolean value) Sets the output state.
void	setPower(int chan, double value) Sets the power.
void	setVoltage(int chan, double value) Sets the voltage.

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

addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getDeviceMonitorUpdateTasks, getFullName, getGroupForChannel, getMonitorUpdateTasksForChannels, getName, getOutputLines, getPath, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelNow, setDisabled, setHwLine, setLine, setLineWarm, 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.HasLifecycle

init, postBuild, postInit, postShutdown, postStart, shutdown, start

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

checkStopped

Field Detail

NETWORK_CONN_INVALID

protected static final int NETWORK_CONN_INVALID

See Also:

Constant Field Values

MON_TYPE_POWER

protected static final int MON_TYPE_POWER

See Also:

Constant Field Values

MON_TYPE_VOLTAGE

protected static final int MON_TYPE_VOLTAGE

See Also:

Constant Field Values

MON_TYPE_CURRENT

protected static final int MON_TYPE_CURRENT

See Also:

Constant Field Values

mTypeMap

protected static final Map<String,Integer> mTypeMap

connType

@ConfigurationParameter(name="connType",
                        category="Refrig",
                        isFinal=true)
protected volatile org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType

devcId

@ConfigurationParameter(name="devcId",
                        category="Refrig",
                        isFinal=true)
protected volatile String devcId

devcParm

@ConfigurationParameter(name="devcParm",
                        category="Refrig",
                        isFinal=true)
protected volatile int devcParm

maxCurrent

protected double[] maxCurrent

softMaxCurrent

protected double softMaxCurrent

minVoltage

protected double minVoltage

settlingTime

protected int settlingTime

psd

protected org.lsst.ccs.drivers.commons.PowerSupplyDriver psd

Constructor Detail

PowerDevice

public PowerDevice(String name,
                   org.lsst.ccs.drivers.commons.PowerSupplyDriver psd,
                   int options,
                   int minChan,
                   int maxChan)

Constructor.

Parameters:

name - The device name

psd - The power supply device driver object

options - The options word

minChan - The minimum channel number

maxChan - The maximum channel number

Method Detail

build

public void build()

Build phase

Specified by:

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

getMinChannel

public int getMinChannel()

Gets the minimum channel number.

Returns:

The minimum channel number

getMaxChannel

public int getMaxChannel()

Gets the maximum channel number.

Returns:

The maximum channel number

getConnType

@Command(type=QUERY,
         description="Gets the connection type")
public org.lsst.ccs.drivers.commons.DriverConstants.ConnType getConnType()

Gets the connection type.

Returns:

The connection type enum

getDevcId

@Command(type=QUERY,
         description="Gets the device ID")
public String getDevcId()

Gets the device ID.

Returns:

The device identification string

getDevcParm

@Command(type=QUERY,
         description="Gets the device parameter")
public int getDevcParm()

Gets the device parameter.

Returns:

The device parameter

initDevice

protected void initDevice()

Performs configuration.

Overrides:

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

initialize

protected void initialize()

Performs full initialization.

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

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 number

type - The channel type string

subtype - The channel subtype string

Returns:

A two-element array containing the encoded type [0] and subtype [1] values.

Throws:

Exception - if any errors found in the parameters.

readChannelGroup

protected void readChannelGroup()

Initializes voltages and currents as unread.

Overrides:

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

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 returned by checkChannel.

Returns:

The value read from the channel

setOnline

protected void setOnline(boolean online)

Sets the online state. If coming on line, set state data from reading the hardware.

Overrides:

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

Parameters:

online - The online state to set: true or false

enableOutput

public void enableOutput(int chan,
                         boolean enable)

Enables the output.

Parameters:

chan - The hardware channel

enable - The enabled state to set

setPower

public void setPower(int chan,
                     double value)

Sets the power.

Parameters:

chan - The hardware channel

value - The power to set, or NaN to use current value

maintainPower

protected void maintainPower()

Maintains the power for all channels at their set value.

getPower

public double getPower(int chan)

Gets the power for a channel.

Parameters:

chan - The hardware channel

Returns:

The power value

isEnabled

public boolean isEnabled(int chan)

Gets the enabled state.

Parameters:

chan - The hardware channel

Returns:

Whether enabled

hasVoltError

public boolean hasVoltError(int chan)

Gets whether a voltage setting error occurred.

Parameters:

chan - The hardware channel

Returns:

The error state

hasNoLoad

public boolean hasNoLoad(int chan)

Gets whether a "no load" error occurred.

Parameters:

chan - The hardware channel

Returns:

The error state

setVoltage

public void setVoltage(int chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage.

Parameters:

chan - The hardware channel

value - The voltage to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

public void setCurrent(int chan,
                       double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the current.

Parameters:

chan - The hardware channel

value - The current to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

public void setOutput(int chan,
                      boolean value)
               throws org.lsst.ccs.drivers.commons.DriverException

Sets the output state.

Parameters:

chan - The hardware channel

value - The output state to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

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

Reads the voltage.

Parameters:

chan - The hardware channel

Returns:

The voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

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

Reads the current.

Parameters:

chan - The hardware channel

Returns:

The current

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutput

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

Gets the output state.

Parameters:

chan - The hardware channel

Returns:

The output state

Throws:

org.lsst.ccs.drivers.commons.DriverException