org.lsst.ccs.subsystem.power

Class PowerDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.power.PowerDevice

All Implemented Interfaces:

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

Direct Known Subclasses:

BK1696Device, BK9130Device, BK9130GroupDevice, BKXLNDevice, CpfeDevice, HamegDevice, Keithley2231Device, N6487Device, N6700Device, SimPowerDevice

public abstract class PowerDevice
extends org.lsst.ccs.monitor.Device

Interface to an ASCII-commanded power supply device.

Author:

Owen Saxton

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CONN_TYPE_NOT_CONFIG
protected org.lsst.ccs.drivers.commons.DriverConstants.ConnType	connType
protected static int	DEVC_ID_NOT_CONFIG
protected static int	DEVC_PARM_NOT_CONFIG
protected String	devcId Data fields.
protected int	devcParm
protected static Logger	LOG Constants.
protected static int	NETWORK_CONN_INVALID
protected org.lsst.ccs.drivers.commons.PowerSupplyDriver	psd

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, org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String devcId, int devcParm, int options, int minChan, int maxChan) Constructor.
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
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a monitoring channel's parameters for validity.
protected void	close() Closes the connection.
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.
protected void	handleException(org.lsst.ccs.drivers.commons.DriverException e) Handle driver exceptions.
protected void	initDevice() Performs configuration.
protected void	initialize() Performs full initialization.
protected double	readChannel(int hwChan, int type) Reads a monitoring channel.
protected double	readCurrent(int hwChan) Reads the current from the hardware.
protected void	readCurrentGroup() Reads a group of currents from the hardware.
protected boolean	readOutput(int hwChan) Reads the power output state from the hardware.
protected void	readOutputGroup() Reads a group of power output states from the hardware.
protected double	readVoltage(int hwChan) Reads the voltage from the hardware.
protected void	readVoltageGroup() Reads a group of voltages from the hardware.
protected void	writeCurrent(double current, int hwChan) Writes the current to the hardware.
protected void	writeCurrentGroup() Writes a group of currents to the hardware.
protected void	writeOffDelay(double offDelay, int hwChan) Writes the power-off delay to the hardware.
protected void	writeOffDelayGroup() Writes a group of power-off delays to the hardware.
protected void	writeOnDelay(double onDelay, int hwChan) Writes the power-on delay to the hardware.
protected void	writeOnDelayGroup() Writes a group of power-on delays to the hardware.
protected void	writeOutput(boolean value, int hwChan) Writes the power output state to the hardware.
protected void	writeOutputGroup() Writes a group of power output states to the hardware.
protected void	writeVoltage(double voltage, int hwChan) Writes the voltage to the hardware.
protected void	writeVoltageGroup() Writes a group of voltages to the hardware.

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, readChannelGroup, readChannelNow, setDisabled, 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.HardwareController

checkStopped

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

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

LOG

protected static final Logger LOG

Constants.

NETWORK_CONN_INVALID

protected static final int NETWORK_CONN_INVALID

See Also:

Constant Field Values

CONN_TYPE_NOT_CONFIG

protected static final int CONN_TYPE_NOT_CONFIG

See Also:

Constant Field Values

DEVC_ID_NOT_CONFIG

protected static final int DEVC_ID_NOT_CONFIG

See Also:

Constant Field Values

DEVC_PARM_NOT_CONFIG

protected static final int DEVC_PARM_NOT_CONFIG

See Also:

Constant Field Values

devcId

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

Data fields.

devcParm

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

connType

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

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

PowerDevice

public PowerDevice(String name,
                   org.lsst.ccs.drivers.commons.PowerSupplyDriver psd,
                   org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                   String devcId,
                   int devcParm,
                   int options,
                   int minChan,
                   int maxChan)

Constructor.

Parameters:

name - The device name

psd - The power supply device driver object

connType - The connection type: network; ftdi; serial

devcId - The device ID: host name; USB serial no.; serial device name

devcParm - The device parameter: port number; baud rate; baud rate

options - The options word

minChan - The minimum channel number

maxChan - The maximum channel number

Method Detail

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

public org.lsst.ccs.drivers.commons.DriverConstants.ConnType getConnType()

Gets the connection type.

Returns:

The connection type string

getDevcId

public String getDevcId()

Gets the device ID.

Returns:

The device identification string

getDevcParm

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 monitoring 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 monitoring 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

writeVoltage

protected void writeVoltage(double voltage,
                            int hwChan)
                     throws PowerException

Writes the voltage to the hardware.

Parameters:

voltage - The voltage to set

hwChan - The hardware channel number

Throws:

PowerException

readVoltage

protected double readVoltage(int hwChan)
                      throws PowerException

Reads the voltage from the hardware.

Parameters:

hwChan - The hardware channel number

Returns:

The read voltage

Throws:

PowerException

writeCurrent

protected void writeCurrent(double current,
                            int hwChan)
                     throws PowerException

Writes the current to the hardware.

Parameters:

current - The current to set

hwChan - The hardware channel number

Throws:

PowerException

readCurrent

protected double readCurrent(int hwChan)
                      throws PowerException

Reads the current from the hardware.

Parameters:

hwChan - The hardware channel number

Returns:

The read current

Throws:

PowerException

writeOnDelay

protected void writeOnDelay(double onDelay,
                            int hwChan)
                     throws PowerException

Writes the power-on delay to the hardware.

Parameters:

onDelay - The delay to set

hwChan - The hardware channel number

Throws:

PowerException

writeOffDelay

protected void writeOffDelay(double offDelay,
                             int hwChan)
                      throws PowerException

Writes the power-off delay to the hardware.

Parameters:

offDelay - The delay to set

hwChan - The hardware channel number

Throws:

PowerException

writeOutput

protected void writeOutput(boolean value,
                           int hwChan)
                    throws PowerException

Writes the power output state to the hardware.

Parameters:

value - The output state to set

hwChan - The hardware channel number

Throws:

PowerException

readOutput

protected boolean readOutput(int hwChan)
                      throws PowerException

Reads the power output state from the hardware.

Parameters:

hwChan - The hardware channel number

Returns:

The power output state

Throws:

PowerException

writeVoltageGroup

protected void writeVoltageGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of voltages to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltageGroup

protected void readVoltageGroup()

Reads a group of voltages from the hardware. May be overridden for devices with this capability

writeCurrentGroup

protected void writeCurrentGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of currents to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrentGroup

protected void readCurrentGroup()

Reads a group of currents from the hardware. May be overridden for devices with this capability

writeOnDelayGroup

protected void writeOnDelayGroup()
                          throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power-on delays to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOffDelayGroup

protected void writeOffDelayGroup()
                           throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power-off delays to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeOutputGroup

protected void writeOutputGroup()
                         throws org.lsst.ccs.drivers.commons.DriverException

Writes a group of power output states to the hardware. May be overridden for devices with this capability

Throws:

org.lsst.ccs.drivers.commons.DriverException

readOutputGroup

protected void readOutputGroup()

Reads a group of power output states from the hardware. May be overridden for devices with this capability

handleException

protected void handleException(org.lsst.ccs.drivers.commons.DriverException e)
                        throws PowerException

Handle driver exceptions.

Parameters:

e - The exception

Throws:

PowerException